Branch mapper

GitHub Action to provide environment context mappings for branch names

Table of contents

• Branch mapper
  • Table of contents
  • Description
  • Inputs
    • github-ref
    • map
  • Outputs
    • environment
  • Examples
  • Visitor stats
  • Licensing
  • Authors
  • Versioning
  • Contribution
  • Acknowledgement
  • Forks
  • Development Support

Description

Parses branch name and optionally maps to corresponding environment name.

Inputs

github-ref

Required GitHub references to parse the current branch from

map

Optional Collection of branch name mappings (default null)

Outputs

environment

Environment branch name by provided collection of name mappings

Examples

- name: Branch name mapping
  uses: alexrogalskiy/github-action-branch-mapper@master
  with:
    github-ref: ${{ github.ref }}
    map: '{ "dev": "staging", "production": "production", ".*": "sandbox" }'

Running locally:

• npm run start:action --action github-action-branch-mapper --github-ref refs/heads/my/branch-name --map '{ "dev": "staging", ".*": "sandbox" }'

Visitor stats

Licensing

Branch mapper is distributed under LGPL version 3 or later, [License]. LGPLv3 is additional permissions on top of GPLv3.

Authors

Branch mapper is maintained by the following GitHub team-members:

• 

with community support please contact with us if you have some question or proposition.

Versioning

The project uses SemVer for versioning. For the versions available, see the tags on this repository.

Contribution

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us (emoji key).

This project follows the all-contributors specification. Contributions of any kind are welcome!

See also the list of contributors who participated in this project.

Acknowledgement

Forks

Development Support

Like Branch mapper ? Consider buying me a coffee :)

---