azu / set-env-to-github_env

A migration tools convert `::set-env`/`::set-output`/`::save-state` to $GITHUB_ENV/$GITHUB_OUTPUT/$GITHUB_STATE on GitHub Actions.

set-env-to-github_env

A migration tools convert ::set-env to $GITHUB_ENV on GitHub Actions.

Supported Migration

• echo "::set-env name={name}::{value}" → echo "{name}={value}" >> "$GITHUB_ENV"
• echo "::set-output name={name}::{value}" → echo "{name}={value}" >> "$GITHUB_OUTPUT"
• echo "::save-state name={name}::{value}" → echo "{name}={value}" >> "$GITHUB_STATE"

For more details, see GitHub blog and documentation.

• GitHub Actions: Deprecating set-env and add-path commands - GitHub Changelog
• GitHub Actions: Deprecating save-state and set-output commands | GitHub Changelog
• Workflow commands for GitHub Actions - GitHub Docs

TODO: This tool does not support ::add-path migration yet. If you are interesting in this, please see #2

Install

Install with npm:

npm install set-env-to-github_env

or Just use npx command in project root directory.

npx set-env-to-github_env

Require: Node.js 14+

Usage

Run command in project root directory.

Usage
  $ set-env-to-github_env

Examples
  $ set-env-to-github_env
  # migration ./github/workflows/*.{yml,yaml}

Example

Before

name: test
on: [push, pull_request]
jobs:
  test:
    name: "Test"
    runs-on: ubuntu-18.04
    steps:
      - name: set env for prod
        if: github.ref == 'refs/heads/main'
        run: |
          echo "::set-env name=FILE_ID::${FILE_ID}"
          echo "::set-env name=BUCKET_NAME::${BUCKET_NAME}"
        env:
          FILE_ID: 123456789012
          BUCKET_NAME: deploy-prod

After

name: test
on: [push, pull_request]
jobs:
  test:
    name: "Test"
    runs-on: ubuntu-18.04
    steps:
      - name: set env for prod
        if: github.ref == 'refs/heads/main'
        run: |
          echo "FILE_ID=${FILE_ID}" >> "$GITHUB_ENV"
          echo "BUCKET_NAME=${BUCKET_NAME}" >> "$GITHUB_ENV"
        env:
          FILE_ID: 123456789012
          BUCKET_NAME: deploy-prod

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

Author

• azu: GitHub, Twitter

License

MIT © azu

set-env-to-github_env's Issues

Add add-path support

echo "::add-path::$HOME/bin"

to be

echo "$HOME/bin" >> $GITHUB_PATH

Welcome to PR.