Skip to content

Commit

Permalink
chore: [m3-6511] Changelog Automation (#9104)
Browse files Browse the repository at this point in the history
* chore: [m3-6511] initial commit

* chore: [m3-6511] Wrap up changeset generation script

* chore: [m3-6511] Some cleanup

* chore: [m3-6511] Wrap up changelog generation script

* chore: [m3-6511] cleanup

* chore: [m3-6511] formatting, try catch blocks, sorting

* chore: [m3-6511] delete job

* chore: [m3-6511] semver prompt

* chore: [m3-6511] cleanup part 1

* chore: [m3-6511] cleanup part 2

* chore: [m3-6511] Adding contribution guide

* chore: [m3-6511] feedback

* feat: [M3-6511] better file naming convention

* feat: [M3-6511] fix commit step

* feat: [M3-6511] Address feedback 1

* feat: [M3-6511] Address feedback 2

* feat: [M3-6511] Address feedback 3
  • Loading branch information
abailly-akamai authored May 16, 2023
1 parent 016cb74 commit 0e7448c
Show file tree
Hide file tree
Showing 14 changed files with 5,897 additions and 2 deletions.
8 changes: 8 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,13 @@ Feel free to open an issue to report a bug or request a feature.
**Example:** `feat: [M3-1234] - Allow user to view their login history`

6. Open a pull request against `develop` and make sure the title follows the same format as the commit message.
7. If needed, create a changeset to populate our changelog
- If you don't have the Github CLI installed or need to update it (you need GH CLI 2.21.0 or greater),
- install it via `brew`: https://cli.github.com/manual/installation or upgrade with `brew upgrade gh`
- Once installed, run `gh repo set-default` and pick `linode/manager` (only > 2.21.0)
- You can also just create the changeset manually, in this case make sure to use the proper formatting for it.
- Run `yarn changeset` and provide a description for the change. You can either have it committed automatically or do it manually
- A changeset is optional, it merely depends if it falls in one of the following categories:
`Added`, `Fixed`, `Changed`, `Removed`, `Tech Stories`

Two reviews from members of the Cloud Manager team are required before merge. After approval, all pull requests are squash merged.
18 changes: 18 additions & 0 deletions packages/manager/.changeset/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Changesets

This directory gets auto-populated when running `yarn changeset`.
You can however add your changesets manually as well, knowing that the [TYPE] is limited to the following options `Added`, `Fixed`, `Changed`, `Removed`, `Tech Stories`, and follow this format:

```md
---
"@linode/manager": [TYPE]
---

My PR Description ([#`PR number`](`PR link`))
```

You must commit them to the repo so they can be picked up for the changelog generation.

This directory get wiped out when running `yarn generate-changelog`.

See `changeset.mjs` for implementation details.
Loading

0 comments on commit 0e7448c

Please sign in to comment.