Skip to content

Commit

Permalink
chore: update release process (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
reynoldsalec authored Jul 3, 2023
1 parent 9146352 commit 07a196d
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 465 deletions.
6 changes: 6 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ jobs:
- name: Run unit tests
run: yarn test:unit

# Prepare release.
- name: Prepare release
uses: lando/prepare-release-action@v2
with:
lando-plugin: true

# Deploy
- name: Publish to npm
run: |
Expand Down
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
## v0.8.0 - [July 3, 2023](https://github.com/lando/varnish/releases/tag/v0.8.0)
* Removed bundle-dependencies and version-bump-prompt from plugin.
* Updated package to use prepare-release-action.
* Updated documentation to reflect new release process.

## v0.7.0 - [December 12, 2022](https://github.com/lando/varnish/releases/tag/v0.7.0)
* Added bundle-dependencies to release process.
* Fixed bug in plugin dogfooding test.
Expand Down
7 changes: 1 addition & 6 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,12 +159,7 @@ For a deeper dive on Leia you can go [here](https://github.com/lando/leia).

## Releasing

To deploy and publish a new version of the package to the `npm` registry you need only [create a release on GitHub](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository). That said, in order to create a release and succesfully publish it to `npm` you will want to make sure:

* You have tagged the commit you want to deploy in `git` and pushed it up to GitHub
* You have bumped the version in your `package.json` so that it doesn't collide with a version already published to `npm`

In order to help with the above we recommend you run the convience command `yarn release` which will take care of both.
To deploy and publish a new version of the package to the `npm` registry you need only [create a release on GitHub](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository). The GitHub release will automatically [prepare the release](https://github.com/lando/prepare-release-action) and deploy it to NPM, so make sure to use the correct semantic version for the release title (ex: \`v0.8.0\`).

Also note that if you create a "pre-release" it will tag the `npm` package with `edge` instead of the default `latest` tag. Also note that while you can toggle the pre-release checkbox after the initial release creation this will not trigger a new release and/or promote the release from `edge` to `latest`. If you want to deploy to `latest` then create a new release without pre-released checked.

Expand Down
3 changes: 0 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@
"docs:build": "vuepress build docs",
"docs:lint": "eslint -c docs/.eslintrc.json --quiet docs/.vuepress",
"lint": "eslint --quiet . && yarn docs:lint",
"release": "bundle-dependencies update && bump --prompt --tag --all --push",
"test:unit": "nyc --reporter=html --reporter=text mocha --timeout 5000 test/**/*.spec.js",
"test:leia": "yarn leia \"examples/**/README.md\" -c 'Destroy tests' --stdin",
"test": "yarn lint && yarn test:unit"
Expand All @@ -52,15 +51,13 @@
"@babel/eslint-parser": "^7.16.0",
"@lando/leia": "^0.6.5",
"@lando/vuepress-theme-default-plus": "1.0.0-beta.45",
"bundle-dependencies": "^1.0.2",
"chai": "^4.3.4",
"command-line-test": "^1.0.10",
"eslint": "^7.32.0",
"eslint-config-google": "^0.9.1",
"eslint-plugin-vue": "^8.0.3",
"mocha": "^9.1.2",
"nyc": "^15.1.0",
"version-bump-prompt": "^4.2.1",
"vuepress": "2.0.0-beta.53"
}
}
Loading

0 comments on commit 07a196d

Please sign in to comment.