* Use ncc instead of saving node_modules * Add branding and correctly point to main file * Cleanup * Update release script * PR Feedback * Update README.md * Update README.md * Update contributors.md * Update description * use node-version instead of version (deprecated) * Update contributors.md * Update README.md * Update README.md * Create yaml-lint-config.yml * Create lint-yaml.yml * Update README.md * Update README.md * Update contributors.md * Update README.md * Update terminology in comments * Spelling & grammar * Consistent file name references * ncc build * Address YAML linting errors * Fix quotes * Bump handlebars from 4.1.2 to 4.5.3 Bumps [handlebars](https://github.com/wycats/handlebars.js) from 4.1.2 to 4.5.3. - [Release notes](https://github.com/wycats/handlebars.js/releases) - [Changelog](https://github.com/wycats/handlebars.js/blob/master/release-notes.md) - [Commits](https://github.com/wycats/handlebars.js/compare/v4.1.2...v4.5.3) Signed-off-by: dependabot[bot] <support@github.com> * Run main workflow on PRs * Match README to action.yml * Update dist/index.js * Update checkout action to v2 * Fix cross-platform build matrix example * output installed version number after setup (#51) * output installed version number after setup * set output for the installed version * Setup python + self hosted runners documentation * Updates to npm packages (#66) * npm package updates * Updates to ncc build * Update action.yml * Update action.yml Co-authored-by: Konrad Pabjan <Konrad.Pabjan@microsoft.com> Co-authored-by: Edward Thomson <ethomson@edwardthomson.com> Co-authored-by: conao3 <conao3@gmail.com> Co-authored-by: Brian Cristante <brcrista@microsoft.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Rui Chen <chenrui333@gmail.com> Co-authored-by: Madhuri Gummalla <madhurig@github.com> Co-authored-by: Ye-hyoung Kang <keepyourhonor@gmail.com> Co-authored-by: Robin Daumann <26201853+robindaumann@users.noreply.github.com>
1.4 KiB
Contributors
Checkin
- Do check in source (
src/
) - Do check in a single
index.js
file after runningncc
- Do not check in
node_modules/
NCC
In order to avoid uploading node_modules/
to the repository, we use zeit/ncc to create a single index.js
file that gets saved in dist/
.
Developing
If you're developing locally, you can run
npm install
tsc
ncc build
Any files generated using tsc
will be added to lib/
, however those files also are not uploaded to the repository and are exluded using .gitignore
.
During the commit step, Husky will take care of formatting all files with Prettier
Testing
We ask that you include a link to a successful run that utilizes the changes you are working on. For example, if your changes are in the branch newAwesomeFeature
, then show an example run that uses setup-python@newAwesomeFeature
or my-fork@newAwesomeFeature
. This will help speed up testing and help us confirm that there are no breaking changes or bugs.
Releases
There is a master
branch where contributor changes are merged into. There are also release branches such as releases/v1
that are used for tagging (for example the v1
tag) and publishing new versions of the action. Changes from master
are periodically merged into a releases branch. You do not need to create any PR that merges changes from master into a releases branch.