https://github.com/serverless/template-package
Repository template for serverless packages
https://github.com/serverless/template-package
Last synced: 8 months ago
JSON representation
Repository template for serverless packages
- Host: GitHub
- URL: https://github.com/serverless/template-package
- Owner: serverless
- License: mit
- Created: 2019-09-11T11:48:36.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2022-02-11T09:52:39.000Z (almost 4 years ago)
- Last Synced: 2025-04-18T07:51:36.184Z (8 months ago)
- Language: JavaScript
- Size: 104 KB
- Stars: 9
- Watchers: 13
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CHANGEME
## Project initialization steps
1. Initialize repository (typically via `git init`)
2. Ensure default branch name is `main` (not `master`)
3. Install dependencies (typically via `npm install`)
4. Acknowledge pre-configured precommit git hooks, they validate changes to be committed against preconfigured _lint_ rules and expected _prettier_ style.
_If for some reason in context of this project you don't find it helpful, ensure to remove all `husky` and `lint-stage` related configuration._
5. Acknowledge pre-configured semi-automation of a [release process](RELEASE_PROCESS.md). For that to work as expected, project is expected to to follow [semantic commit messages](https://www.conventionalcommits.org/en/v1.0.0-beta.4/#summary).
See proposed [Commit Message Guidelines](https://docs.google.com/document/d/1hKUs3qt_aVp_PBI1UqvfaIqKma3jAJimEoGCRGGbOqs/edit#).
_If for some reason in context of this project you don't find it helpful, ensure to remove all `commitlint` and `standard-version` related configuration, and cleanup `.travis.yml`._
6. Fill all occurences of CHANGEME found in any files across a project with expected counterparts. While doing that also remove this section.
7. (_Needed for automatic tagging of new releases and sending release notes_) Configure [serverless-ci](https://github.com/serverless-ci) auth token (just `public_repo` scope is needed) into `USER_GITHUB_TOKEN` GitHub secret for CI/CD
8. (_Needed for npm publications_) Configure [serverless-main](https://www.npmjs.com/~serverless-main) auth token into `NPM_TOKEN` GitHub secret for CI/CD
9. Commit created changes, ideally by combining them into initial commit by pursuing following steps:
- `git stash`
- `git rebase -i --root`
_Change here 'pick' to 'edit' on first commit_
- `git stash pop`
- `git add -A .`
- `git commit --amend '-S'`
_Confirm on initial commit message._
_(note: this one doesn't necessarily need to confirm to commitlint. To make it distinct you may use emotikon as `💥`)_.
- `git rebase --continue`
- `git push -f`
7. Ideally all further updates should go through CI validated and reviewed PR's