Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/the-guild-org/changesets-dependencies-action
A GitHub Action for creating Changesets files for dependencies updates.
https://github.com/the-guild-org/changesets-dependencies-action
action actions changesets dependencies github-action github-actions nodejs npm the-guild
Last synced: about 3 hours ago
JSON representation
A GitHub Action for creating Changesets files for dependencies updates.
- Host: GitHub
- URL: https://github.com/the-guild-org/changesets-dependencies-action
- Owner: the-guild-org
- Created: 2022-08-04T07:22:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-05T11:00:02.000Z (over 1 year ago)
- Last Synced: 2024-10-25T12:41:46.359Z (13 days ago)
- Topics: action, actions, changesets, dependencies, github-action, github-actions, nodejs, npm, the-guild
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/changesetsdependencies
- Size: 5.8 MB
- Stars: 27
- Watchers: 4
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# changesets-dependencies-action
A GitHub Action for creating Changesets files for dependencies updates.
This action will automatically monitor all your PRs, and find changes in `package.json` files. Then it creates/updates a `changeset` file, and commits it to your PR.
> Works great with Renovate and dependabot!
This Action only create Changeset files for the following:
- Packages that are under the monorepo/Workspace and not being ignored.
- Packages that are not marked as `private: true`.
- Packages that are located in `dependencies` or `peerDependencies`.
- Packages that are not ignored by `changesets` config.
## Features
- Automatic Changesets based on changes in `package.json`
- Smart `semver` inference and links to NPM
- Integration with Prettier (for the created YAML file)
- Flexible CI execution (depends on token, see below)
## Usage (with default token)
Create a GitHub Actions workflow with the following:
```yaml
name: dependencies
on: pull_request
jobs:
changeset:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Create/Update Changesets
uses: "the-guild-org/[email protected]"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
## Usage (with custom token)
**Note: using `secrets.GITHUB_TOKEN` will not trigger CI again.**
If you wish that the created commit will also trigger CI, you must create a custom PAT from any regular GitHub user ([instructions here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)).
Then, add it to your repository `Secrets` with a custom name (`MY_GH_TOKEN` in this example. Then, configure the `checkout` action as below and use the custom token for this action:
```yaml
name: dependencies
on: pull_request
jobs:
changeset:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
token: ${{ secrets.MY_GH_TOKEN }} # use it here
- name: Create/Update Changesets
uses: "the-guild-org/[email protected]"
env:
GITHUB_TOKEN: ${{ secrets.MY_GH_TOKEN }} # and also here
```
> The created commit will still appear as `github-actions-bot`, but this time it will run CI ;)
### Inputs
You may also set `preCommit` configuration with a custom script, if you wish to run a script before committing the actual files. This is useful if you want to run custom liting/prettier workflows.