Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.71 KB

developer-guildelines.md

File metadata and controls

34 lines (21 loc) · 1.71 KB
Raw

Dev guidelines to contribute to the existing actions

Fork the repo and setup

  1. Fork the repo and clone it.

  2. Download and install Node.js 12.x or higher, which includes npm version 6.x or higher.

  3. Run “npm install” in the terminal within the repo. This command downloads dependencies defined in a package. json file and generates a node_modules folder with the installed modules.

Make your changes and test

  1. Make the necessary changes to .ts files in the src folder. Run "npm run build” to compile your .ts files into .js files; ensure that these .js files are present in the lib folder .

  2. If there are changes in input and output fields in action, add/remove those fields in action.yml file.

  3. Add unit tests and build. Run "npm run test" to check if unit tests pass . Run "npm run build" to build files and check in your files to the forked repo.

  4. Push your changes to the forked repository. Test your changes by creating a .yml workflow in .github/workflows folder in another repository and provide this repository there in the place of action. For example -

    uses: username/reponame@branch
    with:
     input_A: 
     input_B:

where username/reponame@branch is your forked repo. Remember to checkin node_modules in your forked repository while testing.

PR for main branch

Once code is tested and unit tests are added, please raise a PR against the actual repo’s main branch. Note that node_modules should not be pushed while raising PR against main branch.

Releasing a new version

Proper release tags should be maintained for releasing new versions of the Action. A standard release process is to be followed.