Commit 35dec8b

committed

workflow: set up automated publishing with provenance support

1 parent 8486aa0 commit 35dec8bCopy full SHA for 35dec8b

File tree

+45

-1

lines changed

+45

-1

lines changed

Lines changed: 11 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,11 @@`
	`1`	`+This document explains how to perform the project's maintenance tasks.`
	`2`	`+`
	`3`	`+### Creating a new release`
	`4`	`+`
	`5`	`+Anyone with write access to the main branch of both this repository and [create-vue-templates](https://github.com/vuejs/create-vue-templates/) can request a new release. This includes repository maintainers, repository adminstrators, and Vue.js organization administrators.`
	`6`	`+`
	`7`	`+To do so, follow these steps:`
	`8`	`+`
	`9`	+1. Run `pnpm version <patch\|minor\|major>` locally to bump the version number and create a new commit / tag. The `postversion` script will automatically push the changes to the repository.
	`10`	`+2. The release will be automatically published to npm by GitHub Actions once approved by an administrator.`
	`11`	`+3. Go to <https://github.com/vuejs/create-vue/releases/new> and create a new release with the tag that was just created. Describe the notable changes in the release notes.`

Lines changed: 28 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,28 @@`
	`1`	`+name: Publish`
	`2`	`+`
	`3`	`+on:`
	`4`	`+ push:`
	`5`	`+ tags:`
	`6`	`+ - 'v' # Push events to matching v, i.e. v1.0, v20.15.10`
	`7`	`+`
	`8`	`+jobs:`
	`9`	`+ release:`
	`10`	`+ # Use Publish environment for deployment protection`
	`11`	`+ environment: Publish`
	`12`	`+ runs-on: ubuntu-latest`
	`13`	`+ permissions:`
	`14`	`+ contents: read`
	`15`	`+ id-token: write`
	`16`	`+ steps:`
	`17`	`+ - uses: actions/checkout@v4`
	`18`	`+ - uses: pnpm/action-setup@v3`
	`19`	`+ with:`
	`20`	`+ version: 9`
	`21`	`+ - uses: actions/setup-node@v4`
	`22`	`+ with:`
	`23`	`+ node-version: 'lts/*'`
	`24`	`+ registry-url: 'https://registry.npmjs.org'`
	`25`	`+ - run: pnpm install`
	`26`	`+ - run: pnpm publish`
	`27`	`+ env:`
	`28`	`+ NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}`

Lines changed: 6 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,8 @@`
`23`	`23`	`"pretest": "pnpm run build && pnpm run snapshot",`
`24`	`24`	`"test": "zx ./scripts/test.mjs",`
`25`	`25`	`"test:unit": "vitest",`
`26`		`- "prepublishOnly": "zx ./scripts/prepublish.mjs"`
	`26`	`+ "postversion": "zx ./scripts/postversion.mjs",`
	`27`	`+ "prepublishOnly": "pnpm run build"`
`27`	`28`	`},`
`28`	`29`	`"repository": {`
`29`	`30`	`"type": "git",`
`@@ -58,5 +59,9 @@`
`58`	`59`	`"*.{js,ts,vue,json}": [`
`59`	`60`	`"prettier --write"`
`60`	`61`	`]`
	`62`	`+ },`
	`63`	`+ "publishConfig": {`
	`64`	`+ "access": "public",`
	`65`	`+ "provenance": true`
`61`	`66`	`}`
`62`	`67`	`}`

File renamed without changes.

Comments

(0)