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

README Example should indicate actions/checkout@master is required #109

Closed
CdrMarks opened this issue Nov 28, 2022 · 1 comment · Fixed by #154
Closed

README Example should indicate actions/checkout@master is required #109

CdrMarks opened this issue Nov 28, 2022 · 1 comment · Fixed by #154
Labels
hacktoberfest needs:documentation This requires documentation. type:bug Something isn't working. type:good-first-issue Good for newcomers.
Milestone

Comments

@CdrMarks
Copy link

Describe the bug

The Example in README.md doesn't make it clear that -uses: actions/checkout@master is required. The comment "# Remove or modify this step as needed" introduces further confusion.

Steps to Reproduce

  1. Add a file in .github/workflows/wordpress-plugin-deploy.yml
name: Release pantheon-hud plugin to wp.org
on:
  release:
    types: [published]
jobs:
  release:
    runs-on: ubuntu-latest
    steps:
    - name: WordPress Plugin Deploy
      uses: 10up/[email protected]
      env:
        SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
        SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
        SLUG: ${{ env.SLUG }}
  1. See this error when publishing a release:
> Copying files...
ℹ︎ Using .gitattributes
fatal: not a git repository (or any of the parent directories): .git
fatal: not a git repository (or any of the parent directories): .git
tar: This does not look like a tar archive
tar: Exiting with failure status due to previous errors
Error: Process completed with exit code 2.

Expected behavior

The action would deploy the code in the release to WordPress' SVN server.

Additional context

While debugging the action, we found these two comments on issues where others had done similar things.

You’ve commented out the - uses: actions/checkout@master step, which is necessary to have any of the GitHub repo available for use during the run.

You're missing the line - uses: actions/checkout@master in your tag deploy workflow :) Without that, it will not have any of the contents you're expecting, and it will not be a Git checkout.

@jspellman814
Copy link

Worth noting that actions/checkout@master is no longer in use, and has been converted to actions/checkout@main.

The example in the README (under Deploy on pushing a new tag) mentions actions/checkout@master.

@vikrampm1 vikrampm1 moved this to Incoming in Open Source Practice Nov 29, 2022
@vikrampm1 vikrampm1 added type:bug Something isn't working. needs:documentation This requires documentation. labels Nov 29, 2022
@jeffpaul jeffpaul added the type:good-first-issue Good for newcomers. label Dec 1, 2022
@jeffpaul jeffpaul moved this from Incoming to To Do in Open Source Practice Dec 1, 2022
@jeffpaul jeffpaul added this to the 2.2.0 milestone Dec 1, 2022
carstingaxion added a commit to carstingaxion/distributor-remote-quickedit that referenced this issue Feb 15, 2023
TRY to resolve exit code 0 on deploy which could be related to 10up/action-wordpress-plugin-deploy#109
@jeffpaul jeffpaul modified the milestones: 2.2.0, 2.3.0 May 22, 2023
@jeffpaul jeffpaul moved this from To Do to Code Review in Open Source Practice Oct 10, 2024
@github-project-automation github-project-automation bot moved this from Code Review to Done in Open Source Practice Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest needs:documentation This requires documentation. type:bug Something isn't working. type:good-first-issue Good for newcomers.
Projects
Archived in project
4 participants