From a162920fb438e36aabac41eee26f96b5cb2dc982 Mon Sep 17 00:00:00 2001 From: ChristopherHX Date: Fri, 31 Jan 2025 17:54:54 +0100 Subject: [PATCH] Update Readme and issue templates (#40) --- .github/FUNDING.yml | 1 - .github/ISSUE_TEMPLATE/config.yml | 10 ++-------- .github/ISSUE_TEMPLATE/wiki_issue.yml | 18 ------------------ CONTRIBUTING.md | 8 ++++---- README.md | 6 +++--- pkg/model/workflow.go | 2 +- 6 files changed, 10 insertions(+), 35 deletions(-) delete mode 100644 .github/FUNDING.yml delete mode 100644 .github/ISSUE_TEMPLATE/wiki_issue.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index 83d46d94..00000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1 +0,0 @@ -github: cplee diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 8a074fdd..6757e2de 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,14 +1,8 @@ blank_issues_enabled: true contact_links: - name: Start a discussion - url: https://github.com/nektos/act/discussions/new + url: https://github.com/actions-oss/act-cli/discussions/new about: You can ask for help here! - - name: Ask on Gitter - url: https://gitter.im/nektos/act - about: You can ask for help here! - - name: Ask on Gitter (via Matrix) - url: https://matrix.to/#/#nektos_act:gitter.im?via=gitter.im&via=matrix.org - about: If you prefer Matrix over Gitter - name: Want to contribute to act? - url: https://github.com/nektos/act/blob/master/CONTRIBUTING.md + url: https://github.com/actions-oss/act-cli/blob/main/CONTRIBUTING.md about: Be sure to read contributing guidelines! diff --git a/.github/ISSUE_TEMPLATE/wiki_issue.yml b/.github/ISSUE_TEMPLATE/wiki_issue.yml deleted file mode 100644 index 673628d1..00000000 --- a/.github/ISSUE_TEMPLATE/wiki_issue.yml +++ /dev/null @@ -1,18 +0,0 @@ -name: Wiki issue -description: Report issue/improvement ragarding documentation (wiki) -labels: - - 'kind/discussion' - - 'area/docs' -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this issue! - - type: textarea - id: details - attributes: - label: Details - description: | - Describe issue - validations: - required: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f535d2d1..a6f03636 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,11 +11,11 @@ Help wanted! We'd love your contributions to Act. Please review the following gu Please don't open a GitHub issue for questions about how to use `act`, as the goal is to use issues for managing bugs and feature requests. Issues that are related to general support will be closed and redirected to our gitter room. -For all support related questions, please ask the question in our gitter room: [nektos/act](https://gitter.im/nektos/act). +For all support related questions, please ask the question in discussions: [actions-oss/act-cli](https://github.com/actions-oss/act-cli/discussions). ## Found a Bug? -If you've identified a bug in `act`, please [submit an issue](#issue) to our GitHub repo: [nektos/act](https://github.com/nektos/act/issues/new). Please also feel free to submit a [Pull Request](#pr) with a fix for the bug! +If you've identified a bug in `act`, please [submit an issue](#issue) to our GitHub repo: [actions-oss/act-cli](https://github.com/actions-oss/act-cli/issues/new). Please also feel free to submit a [Pull Request](#pr) with a fix for the bug! ## Have a Feature Request? @@ -31,11 +31,11 @@ Assuming no existing issues exist, please ensure you include required informatio We may have additional questions and will communicate through the GitHub issue, so please respond back to our questions to help reproduce and resolve the issue as quickly as possible. -New issues can be created with in our [GitHub repo](https://github.com/nektos/act/issues/new). +New issues can be created with in our [GitHub repo](https://github.com/actions-oss/act-cli/issues/new). ### Pull Requests -Pull requests should target the `master` branch. Please also reference the issue from the description of the pull request using [special keyword syntax](https://help.github.com/articles/closing-issues-via-commit-messages/) to auto close the issue when the PR is merged. For example, include the phrase `fixes #14` in the PR description to have issue #14 auto close. Please send documentation updates for the [act user guide](https://nektosact.com) to [nektos/act-docs](https://github.com/nektos/act-docs). +Pull requests should target the `master` branch. Please also reference the issue from the description of the pull request using [special keyword syntax](https://help.github.com/articles/closing-issues-via-commit-messages/) to auto close the issue when the PR is merged. For example, include the phrase `fixes #14` in the PR description to have issue #14 auto close. Please send documentation updates for the [act user guide](https://actions-oss.github.io/act-docs/) to [actions-oss/act-docs](https://github.com/actions-oss/act-docs). ### Styleguide diff --git a/README.md b/README.md index 5936c2a6..4974f515 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![act-logo](https://raw.githubusercontent.com/wiki/nektos/act/img/logo-150.png) -# Overview [![push](https://github.com/nektos/act/workflows/push/badge.svg?branch=master&event=push)](https://github.com/nektos/act/actions) [![Join the chat at https://gitter.im/nektos/act](https://badges.gitter.im/nektos/act.svg)](https://gitter.im/nektos/act?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Go Report Card](https://goreportcard.com/badge/github.com/nektos/act)](https://goreportcard.com/report/github.com/nektos/act) [![awesome-runners](https://img.shields.io/badge/listed%20on-awesome--runners-blue.svg)](https://github.com/jonico/awesome-runners) +# Overview > "Think globally, `act` locally" @@ -23,7 +23,7 @@ Let's see it in action with a [sample repo](https://github.com/cplee/github-acti # Act User Guide -Please look at the [act user guide](https://nektosact.com) for more documentation. +Please look at the [act user guide](https://actions-oss.github.io/act-docs/) for more documentation. # Support @@ -35,7 +35,7 @@ Want to contribute to act? Awesome! Check out the [contributing guidelines](CONT ## Manually building from source -- Install Go tools 1.20+ - () +- Install Go tools 1.23+ - () - Clone this repo `git clone git@github.com:actions-oss/act-cli.git` - Run unit tests with `make test` - Build and install: `make install` diff --git a/pkg/model/workflow.go b/pkg/model/workflow.go index 9eeadb03..383a78b3 100644 --- a/pkg/model/workflow.go +++ b/pkg/model/workflow.go @@ -74,7 +74,7 @@ func (w *Workflow) UnmarshalYAML(node *yaml.Node) error { Definition: "workflow-root", Schema: schema.GetWorkflowSchema(), }).UnmarshalYAML(node); err != nil { - return errors.Join(err, fmt.Errorf("Actions YAML Schema Validation Error detected:\nFor more information, see: https://nektosact.com/usage/schema.html")) + return errors.Join(err, fmt.Errorf("Actions YAML Schema Validation Error detected:\nFor more information, see: https://actions-oss.github.io/act-docs/usage/schema.html")) } type WorkflowDefault Workflow return node.Decode((*WorkflowDefault)(w))