diff --git a/nuxt/components/content/Note.vue b/nuxt/components/content/Note.vue new file mode 100644 index 0000000000..642aeddfe2 --- /dev/null +++ b/nuxt/components/content/Note.vue @@ -0,0 +1,8 @@ + diff --git a/nuxt/components/content/RenderFlow.vue b/nuxt/components/content/RenderFlow.vue new file mode 100644 index 0000000000..2926f89d90 --- /dev/null +++ b/nuxt/components/content/RenderFlow.vue @@ -0,0 +1,32 @@ + + + diff --git a/nuxt/content/handbook/engineering/releases/process.md b/nuxt/content/handbook/engineering/releases/process.md index 40057335fa..1848e34bf5 100644 --- a/nuxt/content/handbook/engineering/releases/process.md +++ b/nuxt/content/handbook/engineering/releases/process.md @@ -187,6 +187,29 @@ as needed in coordination with the CTO/Senior Engineer. All release activity should be highlighted in #dept-engineering so the team is aware. +#### `release-please` governed repositories + +::note +A repository's release is managed by the [`release-please`](https://github.com/googleapis/release-please) if the `.github/workflows/release-please.yaml` GitHub Actions workflow exists in the repository. +:: + +The release process is semi-automated in these repositories, with the `release-please` automatically maintaining a release PR that updates the version and changelog when changes are merged to `main`. + +The release manager's role is to review and merge the release PR. Once the release PR is merged, `release-please` will automatically create a Git tag and GitHub Release, and trigger the publish workflow to publish a package/build containers etc. + +For repositories where the `release-please` is configured, the release manager should: + +1. Open the repository on GitHub and locate the release pull request (titled e.g. `chore: Release X.Y.Z`) + * If the release PR does not exist, there is nothing to release +1. Review the proposed version bump and the generated `CHANGELOG.md` entries; make sure the entries reflect the changes that should ship +1. Approve and merge the release PR +1. Confirm that the matching Git tag and GitHub Release have been created +1. Verify the publish workflow, triggered automatically after the release PR is merged, completes successfully + +#### Manual release process + +For repositories that do not yet have `release-please` enabled, follow the manual steps below: + 1. Check that all changes have been merged to main 1. Update the `package.json` version number 1. `cd` into the directory of the package you want to release diff --git a/nuxt/content/handbook/marketing/website.md b/nuxt/content/handbook/marketing/website.md index b240b64555..8085a4abbf 100644 --- a/nuxt/content/handbook/marketing/website.md +++ b/nuxt/content/handbook/marketing/website.md @@ -61,8 +61,8 @@ Guidelines for including images: - Wherever possible use: - The markdown image include tag in blog prose: `![Name of Image](../relative-path-to-image.jpeg)` - You can use the `@skip` tag to disable the image pipeline entirely for an image `![Name of Image](../relative-path-to-image.jpeg "@skip")` - - The NJK shortcode in website body: {% raw %} `{% image "./relative-path-to-image.png", "Image alt tag for screen readers", [150] %}`{% endraw %} - - Where 150 is the maximum width the image will be displayed on the page (source image should be two times this width) + - The MDC image component in page body: `` + - Where `width` is the maximum width the image will be displayed on the page (source image should be two times this width) - GIFs can grow incredibly large, consider using a video in a modern format if the animation is longer than a few seconds ## Non-Image Assets