Skip to content

Commit 284453c

Browse files
committed
Fix GitHub README.md problem
The .github/README.md takes precedence over README.md as being the file which is displayed on a repo's home page, if present. This commit moves the Github Actions readme file deeper into the .github directory to prevent it from displaying the repo's README.md file as the authoritative content to display on the repo's home page. Also perform some maintenacne updates on the Github Actions readme file.
1 parent 6f7e9c6 commit 284453c

File tree

4 files changed

+26
-38
lines changed

4 files changed

+26
-38
lines changed

.github/README.md

-32
This file was deleted.

.github/workflows/README.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# PEADM Workflows for Github Actions
2+
3+
These workflows enable acceptance testing of peadm plans using Github Actions. The Puppet Cloud CI tool from the IAC team is used to provision VMs for testing, and a fixtures module, peadm\_spec, is used to run Bolt-based testing plans. The fixtures module is located in the spec/acceptance/peadm\_spec directory.
4+
5+
## Using workflows
6+
7+
Most workflows start with the same core functionality: provision Cloud CI VMs, then use peadm::provision to install PE. If the installation is successfull, more testing may be performed after that.
8+
9+
If a workflow supports ssh debugging, an optional extra step is added to permit users to ssh into the runner VM prior to the workflow kicking off properly. The credentials and ngrok configuration to enable this must be set as secrets on the Github repository. Once connected, the user can resume flow by touching a "continue" file, and, if they would like flow to pause before tearing down VMs, touch a "pause" file as well. When the pause file is removed, the tear-down will resume.
10+
11+
There are six supported architectures for most tests:
12+
13+
* standard
14+
* standard-with-dr
15+
* large
16+
* large-with-dr
17+
* extra-large
18+
* extra-large-with-dr
19+
20+
### PR Test ###
21+
22+
PRs are tested ONLY when a review is requested. This is to prevent unnecessary and expensive testing runs kicking off simply when filing a PR, waiting instead until a user signals the PR is ready for testing by requesting a review.
23+
24+
### Note for maintainers ###
25+
26+
The `steps:` of each of these three workflows are identical, with the exception of the first step in the debugging flow (which is the ssh step). When modifying the steps of any flow, the others should therefore be updatable with a simple full copy-paste. At some point we should wrap these up into composite flows of their own.

.gitignore

-3
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,3 @@
3232
.plan_cache.json
3333
.resource_types/
3434
bolt-debug.log
35-
!spec/fixtures/modules
36-
spec/fixtures/modules/*
37-
!spec/fixtures/modules/peadm_spec

.sync.yml

-3
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,6 @@ spec/spec_helper.rb:
2323
- '.plan_cache.json'
2424
- '.resource_types/'
2525
- 'bolt-debug.log'
26-
- '!spec/fixtures/modules' # Have to reset this one to correctly not ignore peadm_spec
27-
- 'spec/fixtures/modules/*'
28-
- '!spec/fixtures/modules/peadm_spec'
2926
.github/workflows/auto_release.yml:
3027
unmanaged: false
3128
.github/workflows/release.yml:

0 commit comments

Comments
 (0)