Request : Boilerplate plugin that implements this github action

[kevindaus]

Is your enhancement related to a problem? Please describe.
Not related to a problem -- more of an additional documentation.

Describe the solution you'd like
A boilerplate wordpress plugin project that anyone can just clone and easily test using this github action .

Designs
Foo Wordpress Plugin - a boilerplate wordpress plugin implements this wordpress action.

Describe alternatives you've considered
none

Additional context
It would be cool to see a project that anyone can clone and play with immediately .

Hope you would consider my suggestion . Cheers!

[helen]

Hi @kevindaus! I totally agree, we should add sample workflow files to https://github.com/10up/plugin-scaffold, which you can use as a template when starting a new repo right in GitHub. Is that something you’d be interested in submitting a pull request for? I’m also happy to take care of it.

[madiodio]

Hi there, is there at least any guide on how to get this running at all ? As #10 suggested. It would be awesome if there was a basic step by step to make sure you're not going to run on some errors that could be avoided.

I've migrated this to the new syntax (from HCL to .yml) and can't run successfully the action anymore. It constantly fails on this message that's not really helping fatal: not a git repository (or any parent up to mount point /github)

Thanks.

[helen]

@madiodio 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. While I’m sympathetic to confusion as people get used to the new syntax and Actions in general, I’m not sure it’s worth duplicating general Actions documentation here. What do you think would make the basic example clearer?

[madiodio]

@helen Thanks for pointing that out, including -uses: actions/checkout@master in the steps actually fixes the issue. What confused me was whether or not the npm install was needed at all.

I totally get that it could make duplicate the actual Actions documentations but a simple step by step would not hurt IMHO. I believe this would help maintain this repo like helping reduce issues like this and resolve bugs based on what step the user did get stuck on. For example:

Installation

Step 1 :

• Register your secrets env. keys (SVN_USERNAME and SVN_PASSWORD) ...
• Optionally add SLUG, VERSION, ASSETS_DIR ...

Step 2 : Create a file in .github/workflow named main.ymlfor example, copy the example, make changes if necessary (SLUG) and paste it inside the main.yml file that you just created

Step 3 (Optional) : Create a .distignore (or .gitattributes adding export-ignore at the end of each line) to make sure you're excluding files/folders you don't want to end in the deployed plugin folder

Step 4 : Deploy your plugin as you would by tagging a new version and pushing.

Also, you can fork this repo (link to a template repo maybe 10up/plugin-scaffold ?) clone it and deploy using the previous steps.

---

If this sounds ok for you I can put together a PR.

Thanks.

[helgatheviking]

@madiodio I would love a step by step. I'm meandering my way through right now. I'm stuck on what permissions you need to give your github token so a screenshot of that would be a nice addition to the docs too.

[helen]

@helgatheviking For the typical use case there shouldn’t be much more to it besides copying the base workflow file and adding the SVN_USERNAME and SVN_PASSWORD secrets to the repo settings. GITHUB_TOKEN is not required for this particular Action and is automatically provided by the Actions environment so there’s nothing to configure. Can you describe what you’re doing?

[helgatheviking]

@helen Hi Helen! thank you so much for replying. The first example I looked at for this was in ElasticPress which had a GITHUB_TOKEN in it. But looking at the docs again, and now you've confirmed, that isn't necessary. Thanks for clearing that up!