configured stale action and minor updates to docs (#16)

Author: tom-halpin

.github/workflows/codecommitWorkflow.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
       - name: Check out code.
         uses: actions/checkout@v2
-      - name: Run PySpelling as a GitHub action
+      - name: Spelling check via PySpelling
         uses: sbates130272/spellcheck-github-actions@v0.6.0
   super-linter:
     # Job name
@@ -45,10 +45,10 @@ jobs:
     steps:
       - name: Check out code.
         uses: actions/checkout@v2
-      - name: Validate JSON Schema
+      - name: Validate src/mission.json against JSON Schema
         uses: docker://orrosenblatt/validate-json-action:latest
         env:
-          INPUT_SCHEMA: /src/missions.schema.json
+          INPUT_SCHEMA: ./src/missions.schema.json
           INPUT_JSONS: ./src/missions.json
   react-linting-and-testing:
     runs-on: ubuntu-latest
@@ -71,6 +71,7 @@ jobs:
       run: npm run coverage
   uml-validation:
     name: uml-validation
+    needs: react-linting-and-testing
     runs-on: ubuntu-latest
     steps:
       - name: Check out code.

.github/workflows/pushtoMaster.yml

@@ -2,6 +2,7 @@
 name: Push to Master - Workflow
 'on':
   # Trigger this workflow on a push to the master branch
+  # Work runs all linter checks, and tests if they are successful it builds and deploys application
   push:
     branches:
       - master
@@ -12,7 +13,7 @@ jobs:
     steps:
       - name: Check out code.
         uses: actions/checkout@v2
-      - name: Run PySpelling as a GitHub action
+      - name: Spelling check via PySpelling
         uses: sbates130272/spellcheck-github-actions@v0.6.0
   super-linter:
     # Job name
@@ -45,7 +46,7 @@ jobs:
     steps:
       - name: Check out code.
         uses: actions/checkout@v2
-      - name: Validate JSON Schema
+      - name: Validate src/mission.json against JSON Schema
         uses: docker://orrosenblatt/validate-json-action:latest
         env:
           INPUT_SCHEMA: ./src/missions.schema.json
@@ -98,11 +99,12 @@ jobs:
       - name: Deploy Images
         shell: bash
         run: |
-          echo "fetching the images from the images folder of the master branch into the images folder of the gh-pages branch"
+          echo "Following deployment of the gh-pages branch, need to fetching the images from the images folder of the master branch "
+          echo " into the images folder of the gh-pages branch. This is done to facilitate sequence to sequence links."
           git branch -a
           #git checkout gh-pages
-          # checkout the images folder from the master branches
-          # -- indicates do not interpret any more arguments as command options.
+          # checkout the images folder from the master branch
+          # the -- parameter indicates do not interpret any more arguments as command options.
           # and stage the files
           #git checkout master -- images
           git status
@@ -113,7 +115,7 @@ jobs:
           author_email: "tom_halpin@hotmail.com"
           message: "Deployed Images"
           add: "--all"
-          #ref: "gh-pages"
+          #ref: "gh-pages" # commit is to gh-pages branch
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

.github/workflows/stale.yml

@@ -18,7 +18,11 @@ jobs:
       - uses: actions/stale@v1
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
-          stale-issue-message: 'Stale issue message'
-          stale-pr-message: 'Stale pull request message'
+          stale-issue-message: 'This issue has been marked as Stale because it has been open for 14 days with no activity. Remove the stale label or comment on the issue, or it will be closed in 7 days.'
+          stale-pr-message: 'This PR has been marked as Stale because it has been open for 14 days with no activity. Remove the stale label or comment on the PR, or it will be closed in 7 days.'
           stale-issue-label: 'no-issue-activity'
+          exempt-issue-labels: 'awaiting-approval,work-in-progress'
           stale-pr-label: 'no-pr-activity'
+          exempt-pr-labels: 'awaiting-approval,work-in-progress'
+          days-before-stale: 14
+          days-before-close: 7

CONTRIBUTING.md

@@ -12,10 +12,26 @@ We value and welcome all contributions including
 
 ## Contributing
 
+### Sequences-as-Code repository
+
+Contributions can be made to the improve the base repository.
+
 * The way to collaborate and work on the project is via GitHub: [github.com/dxc-technology/Sequences-as-Code](https://github.com/dxc-technology/Sequences-as-Code)
 * For issues, bug fixes or adding new features, please create and submit a pull request
 * For raising an issue or a defect, please open a [new github issue](https://github.com/dxc-technology/Sequences-as-Code/issues/new)
 
+### Your Missions and Sequences
+
+You should not need to submit a pull request with your dedicated missions and sequences, i.e. missions specific to you and/or your organization.
+
+For instructions on how to
+
+* Stand up a dedicated instance of SaC
+* Add your missions and sequences
+* Perform common SaC tasks please
+
+see the [documentation](./docs/README.md).
+
 ## Pull Requests
 
 We encourage contributions from the community. No fix is too small.
@@ -32,3 +48,5 @@ If your pull request is not accepted at first, please try again after addressing
 * Submit **Pull Request** to the master repository including a brief description of the request. The **Pull Request** should include enough detail to enable the owner of the repository understand and process the request.
 * **@Mention** the team/team members in the comment section so the notification is sent. This alerts the team members of the need to review the code.
 * Wait for the repo admins to review the changes and provide **feedback**.
+
+As noted above please do not submit a pull request with your dedicated missions and sequences, these should be added to a dedicated instance of SaC. For details on how to stand up a dedicated instance see the [documentation](./docs/README.md).

README.md

@@ -1,6 +1,6 @@
 # SaC (Sequences as Code) - README.md
 
-Repository for SaC (Sequences as Code)
+Repository for SaC (Sequences as Code).
 
 ## Purpose
 
@@ -44,14 +44,11 @@ We welcome all contributions please refer to [CONTRIBUTING.MD](/CONTRIBUTING.md)
 
 ## Issues
 
-If you experience some problems with the existing scenarios, please open an
-[issue](https://github.com/dxc-technology/Sequences-as-Code/issues/new/choose)
-and let us know about them.
+If you experience some problems with the existing scenarios, please open an [issue](https://github.com/dxc-technology/Sequences-as-Code/issues/new/choose) and let us know about them.
 
 ## License
 
-This project is licensed under the Mozilla Public License Version 2.0 - see
-the [LICENSE](LICENSE) file for details.
+This project is licensed under the Mozilla Public License Version 2.0 - see the [LICENSE](LICENSE) file for details.
 
 ## Create React App - Bootstrapped Readme.md