NASA-PDS / roundup-action

Do a "roundup", a/k/a PDS-style continuous integration and delivery
Apache License 2.0
1 stars 4 forks source link

Documentation refers to incorrect secret #7

Closed nutjob4life closed 3 years ago

nutjob4life commented 3 years ago

🐛 Describe the bug

The README.md lists an example workflow .yaml file with the following:

env:
    ADMIN_GITHUB_TOKEN: ${{secrets.pat}}
    CODE_SIGNING_KEY:   ${{secrets.CODE_SIGNING_KEY}}
    ossrh_username:     jocowboy
    ossrh_password:     ${{secrets.OSSRH_USERNAME}}
    pypi_username:      snakewrangler
    pypi_password:      ${{secrets.PYPI_PASSWORD}}

However, the ossrh_password's value refers to an OSSRH_USERNAME secret. It should be an OSSRH_PASSWORD secret.

📑 To Reproduce

  1. Go to https://github.com/NASA-PDS/roundup-action
  2. Scroll down to the GitHub-rendered README.
  3. Scroll further down to "Demonstration" section
  4. See the incorrect ossrh_password demonstration value.

🧐 Expected behavior

The entry should read:

ossrh_password: ${{secrets.OSSRH_PASSWORD}}

🧩 Version of Software Used

Output from validate -V:

validate: Command not found.

🩺 Test Data / Additional context

There is no test data nor any additional context.

🖥 Desktop (please complete the following information)

🦄 Applicable requirements

None applicable.

🖼 Screenshots

Screen Shot 2020-11-05 at 3 51 24 PM