-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from Andrews-McMeel-Universal/sync/_8701cf7
🔄 Sync with @Andrews-McMeel-Universal/action_template
- Loading branch information
Showing
8 changed files
with
168 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,21 @@ | ||
| # Contributing | ||
|
|
||
| New branches should always be associated with a Jira ticket. The branch should be prefixed with the issue key and a short description, like so: `jiraIssueType/AMUPRODUCT-1234/hyphenated-issue-summary`. | ||
| ## Branch Naming Convention | ||
|
|
||
| ## Jira Smart Commits | ||
| When creating a new branch, it should be associated with a Jira ticket. The branch name should follow this format: `jiraIssueType/AMUPRODUCT-1234/hyphenated-issue-summary`. | ||
|
|
||
| In scenarios where creating a separate branch for each Jira ticket is not exactly feasible, you can still trigger our automation by using what are called [smart commits](https://confluence.atlassian.com/fisheye/using-smart-commits-960155400.html). | ||
| ## Using Jira Smart Commits | ||
|
|
||
| To use Jira smart commits, you would include the Jira issue key for each commit like so: `[AMUPRODUCT-1234], [AMUPRODUCT-1235] Knocked out the 4 copy edits needed` | ||
| In cases where creating a separate branch for each Jira ticket isn't practical, you can use [smart commits](https://confluence.atlassian.com/fisheye/using-smart-commits-960155400.html) to trigger our automation. Include the Jira issue key in each commit message like this: `[AMUPRODUCT-1234], [AMUPRODUCT-1235] Implemented the 4 required copy edits`. | ||
|
|
||
| ## Creating Pull Requests | ||
| ## Pull Request Process | ||
|
|
||
| Once you have committed your effort in a separate branch, you will need to raise a pull request in Github. While filling out the Pull Request, **Please** follow the pull request template format and write a brief description of any technical details and Jira tickets that are related to the PR. | ||
| After committing your changes in a separate branch, you'll need to create a pull request (PR) on Github. When creating the PR, adhere to the provided PR template format and include a concise description of the technical details and related Jira tickets. | ||
|
|
||
| The recommended title for the pull request is typically just the branch name. Again, if a single issue per branch is not feasible, including a brief title of the effort is acceptable. | ||
| The PR title should ideally be the branch name. If multiple issues are addressed in a single branch, a brief, descriptive title is acceptable. | ||
|
|
||
| You do not need to fill in the reviewers or assignees. Our CODEOWNERS automation takes care of who will need to review it. As long as a AMU software engineer reviews it and the other checks pass, they will take care of merging the pull request into staging and production. | ||
| You don't need to specify reviewers or assignees. Our CODEOWNERS automation determines who will review your PR. Once an AMU software engineer reviews and approves your PR, and all checks pass, they will merge your PR into the staging and production branches. | ||
|
|
||
| > NOTE: On every PR, we do run tests and automatically format the code with Prettier. | ||
| > **NOTE:** Every PR triggers tests and automatic code formatting with Prettier. | ||
| > NOTE: A PR will not be able to be merged until at least 1 reviewer with write access has approved it and all tests are passing. If a PR is updated with a new commit, stale reviews will be dismissed. | ||
| > **NOTE:** A PR can't be merged until at least one reviewer with write access approves it and all tests pass. If a PR is updated with a new commit, previous reviews will be dismissed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,7 @@ on: | |
| types: [closed] | ||
| schedule: | ||
| - cron: 0 0 * * 0 | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| cleanup: | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,45 @@ | ||
| # Action Template | ||
|
|
||
| Yarn Install composite action for yarn 3/4+ and "nodeLinker: node-modules" | ||
| This is a Yarn Install composite action designed for Yarn versions 3/4+ and "nodeLinker: node-modules". It helps to cache and speed up your Yarn installations in your GitHub workflows. | ||
|
|
||
| Reference: https://gist.github.com/belgattitude/042f9caf10d029badbde6cf9d43e400a | ||
| Reference: [Gist](https://gist.github.com/belgattitude/042f9caf10d029badbde6cf9d43e400a) | ||
|
|
||
| ## Getting Started | ||
|
|
||
| To get started, clone the repository: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/Andrews-McMeel-Universal/cache-yarn-install | ||
| ``` | ||
|
|
||
| ## Installation | ||
|
|
||
| To make `cache-yarn-install` a part of your workflow, just add a step to one of your workflows in your `.github/workflows/` directory in your GitHub repository. | ||
| To integrate `cache-yarn-install` into your workflow, add a step to one of your workflows in the `.github/workflows/` directory of your GitHub repository. | ||
|
|
||
| > Requirement: @setup/node should be run before | ||
| > **Note:** The `@setup/node` action should be run before this action. | ||
| Example: | ||
| Here's an example of how to use it: | ||
|
|
||
| ```YAML | ||
| - name: Cache Yarn Install | ||
| uses: Andrews-McMeel-Universal/cache-yarn-install@v1 | ||
| with: | ||
| enable-corepack: false | ||
| cwd: ${{ github.workspace }}/apps/my-app | ||
| cache-prefix: add cache key prefix | ||
| cache-prefix: 'your-cache-key-prefix' | ||
| cache-node-modules: false | ||
| cache-install-state: false | ||
| ``` | ||
| ## Options | ||
| | Variable | Description | Required | `[Default]` | | ||
| | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | :------: | ----------- | | ||
| | `cwd` | Changes node's process.cwd() if the project is not located on the root. Default to process.cwd() | | `.` | | ||
| | `cache-prefix` | Add a specific cache-prefix | | `'default'` | | ||
| | `cache-npm-cache` | Cache npm global cache folder often used by node-gyp, prebuild binaries (invalidated on lock/os/node-version) | | `'true'` | | ||
| | `cache-node-modules` | Cache node_modules, might speed up link step (invalidated lock/os/node-version/branch) | | `'false'` | | ||
| | `cache-install-state` | Cache yarn install state, might speed up resolution step when node-modules cache is activated (invalidated lock/os/node-version/branch) | | `'false'` | | ||
| | `enable-corepack` | Enable corepack | | `'true'` | | ||
| Here are the options you can configure for this action: | ||
| | Variable | Description | Required | Default | | ||
| | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | :------: | ------- | | ||
| | `cwd` | Changes node's process.cwd() if the project is not located at the root. Defaults to process.cwd() | No | `.` | | ||
| | `cache-prefix` | Adds a specific cache-prefix. | No | `'default'` | | ||
| | `cache-npm-cache` | Caches npm global cache folder often used by node-gyp, prebuild binaries. Invalidated on lock/os/node-version changes. | No | `'true'` | | ||
| | `cache-node-modules` | Caches node_modules to potentially speed up the link step. Invalidated on lock/os/node-version/branch changes. | No | `'false'` | | ||
| | `cache-install-state` | Caches yarn install state to potentially speed up the resolution step when node-modules cache is activated. Invalidated on lock/os/node-version/branch changes. | No | `'false'` | | ||
| | `enable-corepack` | Enables corepack. | No | `'true'` | |