https://github.com/aquaron/vdeploy

Deploy by creating a release, modify changelog, and update version using PR
https://github.com/aquaron/vdeploy

changelog cli deploy github pull-request release version

Last synced: about 2 months ago
JSON representation

Deploy by creating a release, modify changelog, and update version using PR

• Host: GitHub
• URL: https://github.com/aquaron/vdeploy
• Owner: aquaron
• License: mit
• Created: 2020-11-03T19:33:18.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-03-12T21:55:16.000Z (10 months ago)
• Last Synced: 2024-04-26T11:46:45.463Z (8 months ago)
• Topics: changelog, cli, deploy, github, pull-request, release, version
• Language: Shell
• Homepage: https://www.npmjs.com/package/@aquaron/vdeploy
• Size: 72.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @aquaron/vdeploy [![badge-build]][vdeploy] ![badge-vdeploy]

Automate versioning (and changelogs) when a release is created.

## Use

```sh

$ vdeploy

```

That's it! It'll walk you through the setup process the first time.

You will need to edit `.github/workflows/vdeploy.yml` to match your release process.

See this package's [vdeploy.yml] to get an idea how to set one up for your project.

### Process

- Install the `vdeploy.yml` and `incr-version.sh` in the right places

- Checks for outstanding PR and merge them (requires GitHub CLI)

- Update `CHANGELOG.md` from commit log (you can editable, vim)

- Create a release  with the next version number as tag and title (editable)

## Files

### `.github/workflows/vdeploy.yml`

When a release is created:

- Triggers deployment workflow (see the file)

- Increment `package.json`'s _minor_ `version`

- Create a PR of the modified `package.json`

### `.github/scripts/incr-version.sh`

Increment the version number _minor_ based on what was just released.

[vdeploy.yml]: https://github.com/aquaron/vdeploy/blob/master/.github/workflows/vdeploy.yml

[badge-build]: https://github.com/aquaron/vdeploy/workflows/NPM%20Package/badge.svg

[vdeploy]: https://www.npmjs.com/package/@aquaron/vdeploy

[badge-vdeploy]: https://img.shields.io/npm/v/@aquaron/vdeploy?label=vdeploy&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA4MDAgODAwIj48cGF0aCBmaWxsPSIjMzMzIiBkPSJNODAwIDQwMEE0MDAgNDAwIDAgMDA0MDAgMCA0MDAgNDAwIDAgMDAwIDQwMGE0MDAgNDAwIDAgMDA0MDAgNDAwIDQwMCA0MDAgMCAwMDQwMC00MDB6Ii8+PHBhdGggZmlsbD0iI2ZmZGU3NSIgZD0iTTQwMCAxMTMuNmMtNTUuNSAxNjUuMy0yMDkuNiAyMTUtMjA5LjYgMzc5LjIgMCAxMDcgMTAyLjcgMTkzLjYgMjA5LjYgMTkzLjYgMTA2LjcgMCAyMDkuNi04Ni43IDIwOS42LTE5My42IDAtMTU5LjItMTQ0LTIxMC43LTIwOS42LTM3OS4yem0wIDUzMi41Yzg0LjUtMTM5LjctNTMuMy0zMzYuNSAxLjMtNDQwIDI0LjggNDAgNTIuNiA3My4xIDc4LjIgMTAzLjggNTAuMSA1OS43IDg5LjggMTA2LjYgODkuOCAxODIuOSAwIDgwLTgwLjggMTUzLjMtMTY5LjMgMTUzLjN6Ii8+PHBhdGggZD0iTTQwMCAwdjIwOC41Yy0xOS4zIDM5LjQtMTIgOTEuNyAwIDE0OSAxOS43IDk0LjQgNTIuMiAyMDIuMyAwIDI4OC41djE1NGE0MDAgNDAwIDAgMDA0MDAtNDAwQTQwMCA0MDAgMCAwMDQwMCAweiIgb3BhY2l0eT0iLjUiLz48L3N2Zz4K&color=ffde75