Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplifies Token Setup #530

Merged
merged 10 commits into from
Dec 10, 2020
Merged

Simplifies Token Setup #530

merged 10 commits into from
Dec 10, 2020

Conversation

JamesIves
Copy link
Owner

Description

Provide a description of what your changes do.

Removes ACCESS_TOKEN and GITHUB_TOKEN input variables and simply replaces them with TOKEN. As ${{ secrets.token }} is available for us to default in the action.yml file we no longer need to actually have the user define it in 90% of most use cases. If the user wants to use a PAT to deploy cross-repository they can define one by inputting TOKEN, otherwise it will default. This is another step towards simplifying the boilerplate, now only the user needs to provide a folder and a branch.

Testing Instructions

Give us step by step instructions on how to test your changes.

  • Try it using the default provided token method.
  • Try it by adding a PAT using the token input.
  • This does not effect the SSH key setup, which is a separate ticket.

Additional Notes

Anything else that will help us test the pull request.

This is how other GitHub maintained actions handle this, so this also brings us more inline with them.

@JamesIves JamesIves added testing 🧪 This change is being tested. version 4 Issues related to version 4 of this action. labels Dec 8, 2020
@JamesIves JamesIves changed the base branch from dev to dev-v4 December 8, 2020 15:56
@codecov-io
Copy link

Codecov Report

❗ No coverage uploaded for pull request base (dev-v4@9519895). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             dev-v4      #530   +/-   ##
==========================================
  Coverage          ?   100.00%           
==========================================
  Files             ?         5           
  Lines             ?       164           
  Branches          ?        39           
==========================================
  Hits              ?       164           
  Misses            ?         0           
  Partials          ?         0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9519895...506b21d. Read the comment docs.

@JamesIves JamesIves linked an issue Dec 8, 2020 that may be closed by this pull request
@JamesIves JamesIves added this to the 4.0.0 milestone Dec 8, 2020
Copy link
Contributor

@Pike Pike left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great. Found a few nits.

There's one more GITHUB_TOKEN in the README, in line 67.

I found one typo twice, too.

action.yml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
JamesIves and others added 4 commits December 9, 2020 10:04
Co-authored-by: Axel Hecht <axel@pike.org>
Co-authored-by: Axel Hecht <axel@pike.org>
@JamesIves JamesIves merged commit 7a94841 into dev-v4 Dec 10, 2020
@JamesIves JamesIves deleted the simplifies-token branch December 10, 2020 16:49
JamesIves added a commit that referenced this pull request Feb 6, 2021
* Stop checking out workspace (#515)

* Stop checking out base branch before deployment, drop option.

* Don't check out default branch, as we don't check out base branch, drop option.

* Don't stash/unstash as we don't update the workdir, drop preserve option.

* Don't init the workspace

* Only fetch the remote branch if it exists, only with depth 1.

* Rely on previous checkouts to have handled lfs files correctly, drop option.

* Update README, action.yml, integration tests

* Set up eslint for test files. (#517)

* Add DRY_RUN option, passing --dry-run to git push. (#526)

See #499 for the proposal.

* Simplifies Token Setup (#530)

* Token simplification

* Access Token / Github Token -> Token

* Oops

* Typos

* Update README.md

* Update README.md

* Update action.yml

Co-authored-by: Axel Hecht <axel@pike.org>

* Update README.md

Co-authored-by: Axel Hecht <axel@pike.org>

* Update README.md

Co-authored-by: Axel Hecht <axel@pike.org>

* Adjust codeql action to latest recommendations (#540)

Also, add the dev and release branches, and drop master.

* Add workflow to update build and node_modules on release branches (#541)

* Stores username/email in secrets

* Removing stale bot integration

* Test current code base as an integration test for PRs and pushes (#505)

* Add a build step to create lib and node_modules artifact

* Run integration test with built dist and current SHA as base

For pull requests, the github.sha is the sha of the merge to the
target branch, not the head of the PR. Special case that.

* Use v2 checkout, and DRY_RUN for the integration test.

I also made the branches more generic, as there are now more of them.

* Fix #536, don't push at all on dryRun

Also add tests for dryRun and singleCommit and generateBranch
code flows.

* Try to fix dryRun on new remote branches, refactor fetch

* Try to fix dryRun, only fetch if origin branch exists

* Refactor worktree setup to include branch generation and setup for singleCommit

This is a continuation of the no-checkout work, and sadly suggested pretty
intensive changes.

* Set up git config to fix tests, also make debugging easier

* Add matrix for existing and non-existing branch

* Add matrix for singleCommit and not

* Drop GITHUB_TOKEN, add DRY_RUN to action.yml

* When deploying existing branch, add a modifcation and deploy again

* Force branch checkout to work in redeployment scenarios

* Make singleCommit easier to see in job descriptions

* Review comments

* Add a test-only property to action to test code paths with remote branch.

* Introduce TestFlag enum to signal different test scenarios to unit tests

* Fix util.test.ts

* Update worktree.ts

* Fix a few nits in tests and automation. Don't try to wordcount ls-rem… (#546)

* Fix a few nits in tests and automation. Don't try to wordcount ls-remote.

Nits in tests are around undoing changes made to the environment,
and to not modify the checkout.

* Describe suite with empty SHA

* Lowercase Inputs (#547)

* Lowercases inputs

* Adjusts workflow tests and deployment_status

* Use multi-line string for clean-exclude patterns. (#553)

As this change is subtle, I'm taking the opportunity to change
the underscore for the hyphen, which makes it less likely that
users of this action will just pass in an old json array.

* Hyphenate inputs and outputs, add step output, fix #558 (#559)

* Hyphenate inputs and outputs, add step output, fix #558

I've also tried to make the clean docs a bit clearer, and consistent
about clean being on my default. Still not totally happy with the intro
of the docs there, though.

* Add testing of step outputs to build integration tests

* Security Docs

* Integration tests

* Revert "Integration tests"

This reverts commit 639ff53.

* Native SSH Key Support (#569)

* SSH Key Support 🔑

* Update ssh.ts

* Update src/ssh.ts

Co-authored-by: Axel Hecht <axel@pike.org>

* README fixes/etc

* Unit Tests & README

* ssh key

* Update README.md

* Update ssh.test.ts

* Update ssh.test.ts

* Update ssh.test.ts

* Update ssh.test.ts

* Update ssh.test.ts

* Update ssh.test.ts

* Update integration.yml

Co-authored-by: Axel Hecht <axel@pike.org>

* Deployment Issues (#583)

* Update git.ts

* Tests

* Update git.ts

* Formatting

* Update src/git.ts

Co-authored-by: Axel Hecht <axel@pike.org>

* TestFlag

* Logging

* Update git.ts

Co-authored-by: Axel Hecht <axel@pike.org>

* Codespace Support (#584)

* Add files via upload

* Update README.md

* Add files via upload

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* SSH Issues (#588)

* Unsets Persisted Credentials (#587)

* Persist

* Config Setup/Tests

* Assets

* Update git.ts

* Spacing

* Update integration.yml

* Update README.md

Co-authored-by: Axel Hecht <axel@pike.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
testing 🧪 This change is being tested. version 4 Issues related to version 4 of this action.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove the need for the GITHUB_TOKEN variable
3 participants