hackforla / admin-new-project-provisioning Goto Github PK

Overview

We need to define what new projects need (checklist) and how to do each of the steps, so that new admin members can setup a project.

Action Items

• Revise this issue action items to reflect the items from workflow modeling
• Record doing each of the actions
• Turn recordings into wiki pages
• Create issue template for starting up a new project

Resources/Instructions

• Workflow modeling issue template
• https://squidfunk.github.io/mkdocs-material/

Overview

We need to fix the docs deployment issue in new projects, so that it is working from the start.

Action Items

• fix ci.yml where it outputs a permissions error
• Document the options when creating the new repo so that the docs deployment works

Resources/Instructions

Existing template mkdocs workflow

• it runs the workflow after the new project is created, but fails on a permissions error

  INFO    -  Copying '/home/runner/work/test-new-project5/test-new-project5/site' to 'gh-pages' branch and pushing to GitHub.
  remote: Permission to fyliu/test-new-project5.git denied to github-actions[bot].
  fatal: unable to access 'https://github.com/fyliu/test-new-project5/': The requested URL returned error: 403
  

• it has to do with what workflows are allowed to do
  • to solve this: [this does not work. The setting doesn't carry over to the new repo, and the permissions is too broad. We should limit it to just the workflows that need it]
    • go to Setting, Actions->General, Workflow permissions->Read and write permissions
    • Save
  • [new] to solve this:
    • add this to ci.yml in deploy: before steps:

      permissions: 
         contents: write 
      

• rerun the workflow in the Actions tab and it will build the documentation but not expose it to gh-pages
  • to solve this:
    • go to Settings, Pages, Build and deployment->Source->Deploy from a branch, Branch->gh-pages
• now the mkdocs ci.yml workflow should work as intended

When creating a new repo from template

• be sure to “include all branches” so it comes with gh-pages branch
• make it public so that it can serve gh pages

Overview

REPLACE THIS TEXT -Text here that clearly states the purpose of this issue in 2 sentences or less.

Action Items

REPLACE THIS TEXT -If this is the beginning of the task this is most likely something to be researched and documented.

REPLACE THIS TEXT -If the issue has already been researched, and the course of action is clear, this will describe the steps. However, if the steps can be divided into tasks for more than one person, we recommend dividing it up into separate issues, or assigning it as a pair programming task.

Resources/Instructions

How to create a template

• Instructional Video

One Sheet Resources

• One Sheet Template
• Create a New One Sheet Template