website: Bump prettier from 3.3.3 to 3.4.1 in /website (#12205)
* website: Bump prettier from 3.3.3 to 3.4.1 in /website Bumps [prettier](https://github.com/prettier/prettier) from 3.3.3 to 3.4.1. - [Release notes](https://github.com/prettier/prettier/releases) - [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md) - [Commits](https://github.com/prettier/prettier/compare/3.3.3...3.4.1) --- updated-dependencies: - dependency-name: prettier dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * update formatting Signed-off-by: Jens Langhammer <jens@goauthentik.io> * sigh Signed-off-by: Jens Langhammer <jens@goauthentik.io> * disable flaky test Signed-off-by: Jens Langhammer <jens@goauthentik.io> --------- Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Jens Langhammer <jens@goauthentik.io> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jens Langhammer <jens@goauthentik.io>
This commit is contained in:
@ -2,55 +2,55 @@
|
||||
|
||||
### Creating a standard release
|
||||
|
||||
- Ensure a branch exists for the version family (for 2022.12.2 the branch would be `version-2022.12`)
|
||||
- Merge all the commits that should be released on the version branch
|
||||
- Ensure a branch exists for the version family (for 2022.12.2 the branch would be `version-2022.12`)
|
||||
- Merge all the commits that should be released on the version branch
|
||||
|
||||
If backporting commits to a non-current version branch, cherry-pick the commits.
|
||||
|
||||
- Check if any of the changes merged to the branch make changes to the API schema, and if so update the package `@goauthentik/api` in `/web`
|
||||
- Push the branch, which will run the CI pipeline to make sure all tests pass
|
||||
- Create the version subdomain for the version branch ([see](https://github.com/goauthentik/terraform/commit/87792678ed525711be9c8c15dd4b931077dbaac2)) and add the subdomain in Netlify ([here](https://app.netlify.com/sites/authentik/settings/domain))
|
||||
- Create/update the release notes
|
||||
- Check if any of the changes merged to the branch make changes to the API schema, and if so update the package `@goauthentik/api` in `/web`
|
||||
- Push the branch, which will run the CI pipeline to make sure all tests pass
|
||||
- Create the version subdomain for the version branch ([see](https://github.com/goauthentik/terraform/commit/87792678ed525711be9c8c15dd4b931077dbaac2)) and add the subdomain in Netlify ([here](https://app.netlify.com/sites/authentik/settings/domain))
|
||||
- Create/update the release notes
|
||||
|
||||
#### For initial releases:
|
||||
|
||||
- Copy `website/docs/releases/_template.md` to `website/docs/releases/v2022.12.md` and replace `xxxx.x` with the version that is being released
|
||||
- Copy `website/docs/releases/_template.md` to `website/docs/releases/v2022.12.md` and replace `xxxx.x` with the version that is being released
|
||||
|
||||
- Fill in the section of `Breaking changes` and `New features`, or remove the headers if there's nothing applicable
|
||||
- Fill in the section of `Breaking changes` and `New features`, or remove the headers if there's nothing applicable
|
||||
|
||||
- Run `git log --pretty=format:'- %s' version/2022.11.3...version-2022.12`, where `version/2022.11.3` is the tag of the previous stable release. This will output a list of all commits since the previous release.
|
||||
- Run `git log --pretty=format:'- %s' version/2022.11.3...version-2022.12`, where `version/2022.11.3` is the tag of the previous stable release. This will output a list of all commits since the previous release.
|
||||
|
||||
- Paste the list of commits since the previous release under the `Minor changes/fixes` section.
|
||||
- Paste the list of commits since the previous release under the `Minor changes/fixes` section.
|
||||
|
||||
Run `make gen-changelog` and use the contents of `changelog.md`. Remove merged PRs from bumped dependencies unless they fix security issues or are otherwise notable. Remove merged PRs with the `website/` prefix.
|
||||
|
||||
- Sort the list of commits alphabetically and remove all commits that have little importance, like dependency updates and linting fixes
|
||||
- Sort the list of commits alphabetically and remove all commits that have little importance, like dependency updates and linting fixes
|
||||
|
||||
- Run `make gen-diff` and copy the contents of `diff.md` under `API Changes`
|
||||
- Run `make gen-diff` and copy the contents of `diff.md` under `API Changes`
|
||||
|
||||
- Update `website/sidebars.js` to include the new release notes, and move the oldest release into the `Previous versions` category.
|
||||
- Update `website/sidebars.js` to include the new release notes, and move the oldest release into the `Previous versions` category.
|
||||
|
||||
If the release notes are created in advance without a fixed date for the release, only add them to the sidebar once the release is published.
|
||||
|
||||
- Run `make website`
|
||||
- Run `make website`
|
||||
|
||||
#### For subsequent releases:
|
||||
|
||||
- Paste the list of commits since the previous release into `website/docs/releases/v2022.12.md`, creating a new section called `## Fixed in 2022.12.2` underneath the `Minor changes/fixes` section
|
||||
- Paste the list of commits since the previous release into `website/docs/releases/v2022.12.md`, creating a new section called `## Fixed in 2022.12.2` underneath the `Minor changes/fixes` section
|
||||
|
||||
- Run `make gen-changelog` and use the contents of `changelog.md`. Remove merged PRs from bumped dependencies unless they fix security issues or are otherwise notable. Remove merged PRs with the `website/` prefix.
|
||||
- Run `make gen-changelog` and use the contents of `changelog.md`. Remove merged PRs from bumped dependencies unless they fix security issues or are otherwise notable. Remove merged PRs with the `website/` prefix.
|
||||
|
||||
- Run `make gen-diff` and copy the contents of `diff.md` under `API Changes`, replacing the previous changes
|
||||
- Run `make gen-diff` and copy the contents of `diff.md` under `API Changes`, replacing the previous changes
|
||||
|
||||
- Run `make website`
|
||||
- Run `make website`
|
||||
|
||||
- Run `bumpversion` on the version branch with the new version (i.e. `bumpversion --new-version 2022.12.2 minor --verbose`)
|
||||
- Push the tag and commit
|
||||
- A GitHub actions workflow will start to run a last test in container images and create a draft release on GitHub
|
||||
- Edit the draft GitHub release
|
||||
- Run `bumpversion` on the version branch with the new version (i.e. `bumpversion --new-version 2022.12.2 minor --verbose`)
|
||||
- Push the tag and commit
|
||||
- A GitHub actions workflow will start to run a last test in container images and create a draft release on GitHub
|
||||
- Edit the draft GitHub release
|
||||
|
||||
- Make sure the title is formatted `Release 2022.12.0`
|
||||
- Add the following to the release notes
|
||||
- Make sure the title is formatted `Release 2022.12.0`
|
||||
- Add the following to the release notes
|
||||
|
||||
```
|
||||
See https://goauthentik.io/docs/releases/2022.12
|
||||
@ -62,11 +62,11 @@
|
||||
See https://goauthentik.io/docs/releases/2022.12#fixed-in-2022121
|
||||
```
|
||||
|
||||
- Auto-generate the full release notes using the GitHub _Generate Release Notes_ feature
|
||||
- Auto-generate the full release notes using the GitHub _Generate Release Notes_ feature
|
||||
|
||||
### Preparing a security release
|
||||
|
||||
- Create a draft GitHub Security advisory
|
||||
- Create a draft GitHub Security advisory
|
||||
|
||||
<details>
|
||||
<summary>Template</summary>
|
||||
@ -96,14 +96,14 @@ Describe a workaround if possible
|
||||
|
||||
If you have any questions or comments about this advisory:
|
||||
|
||||
- Email us at [security@goauthentik.io](mailto:security@goauthentik.io).
|
||||
- Email us at [security@goauthentik.io](mailto:security@goauthentik.io).
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
- Request a CVE via the draft advisory
|
||||
- If possible, add the original reporter in the advisory
|
||||
- Implement a fix on a local branch `security/CVE-...`
|
||||
- Request a CVE via the draft advisory
|
||||
- If possible, add the original reporter in the advisory
|
||||
- Implement a fix on a local branch `security/CVE-...`
|
||||
|
||||
The fix must include unit tests to ensure the issue can't happen again in the future
|
||||
|
||||
@ -113,9 +113,9 @@ If you have any questions or comments about this advisory:
|
||||
|
||||
Include the new file in the `/website/sidebars.js`
|
||||
|
||||
- Check with the original reporter that the fix works as intended
|
||||
- Wait for GitHub to assign a CVE
|
||||
- Announce the release of the vulnerability via Mailing list and discord
|
||||
- Check with the original reporter that the fix works as intended
|
||||
- Wait for GitHub to assign a CVE
|
||||
- Announce the release of the vulnerability via Mailing list and discord
|
||||
|
||||
<details>
|
||||
<summary>Mailing list template</summary>
|
||||
@ -139,12 +139,12 @@ We'll be publishing a security Issue (CVE-2022-xxxxx) and accompanying fix on _d
|
||||
|
||||
### Creating a security release
|
||||
|
||||
- On the date specified in the announcement, push the local `security/CVE-2022-xxxxx` branch into a PR, and squash merge it if the pipeline passes
|
||||
- If the fix made any changes to the API schema, merge the PR to update the web API client
|
||||
- Cherry-pick the merge commit onto the version branch
|
||||
- If the fix made any changes to the API schema, manually install the latest version of the API client in `/web`
|
||||
- Resume the instructions above, starting with the `bumpversion` step
|
||||
- After the release has been published, update the Discord announcement and send another mail to the mailing list to point to the new releases
|
||||
- On the date specified in the announcement, push the local `security/CVE-2022-xxxxx` branch into a PR, and squash merge it if the pipeline passes
|
||||
- If the fix made any changes to the API schema, merge the PR to update the web API client
|
||||
- Cherry-pick the merge commit onto the version branch
|
||||
- If the fix made any changes to the API schema, manually install the latest version of the API client in `/web`
|
||||
- Resume the instructions above, starting with the `bumpversion` step
|
||||
- After the release has been published, update the Discord announcement and send another mail to the mailing list to point to the new releases
|
||||
|
||||
<details>
|
||||
<summary>Mailing list template</summary>
|
||||
|
Reference in New Issue
Block a user