Add instructions to use activity action.

CMU-313 · Jan 25, 2024 · d4b5339 · d4b5339
1 parent 138d3e5
commit d4b5339
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/docs/projects/P2/1_teamprocess.md b/docs/projects/P2/1_teamprocess.md
@@ -45,6 +45,23 @@ For this project, you will create issues or pull requests **directly in your tea
 
 For each code-based deliverable, we will look at a snapshot of your repository at the deadline. This will often be done by asking you for a screenshot or commit link submitted via Gradescope.
 
+### Setup Activity Action
+
+To help you to understand your contributions through the semester. We added an `activity-action` for you, which automatically pulls the commit and issue histories and updates the `README.md` file in the main branch.
+
+To enable `activity-action`, you need to create a Github token and add that to your team repository. You can create a new token by going to your profile settings: `Developer settings` > `Personal access tokens` > `Tokens (classic)` > `Generate new token`. You do **NOT** need to select any scopes. Set the expiration date on `May 24, 2024`, and put note `17-313 Project Token`. > `Generate token`. Copy the generated token. **Do not close the page unless you finish the next step. You won't be albe to see it again!**
+
+Next, you need to add the generated Github token to your repository secrets. Goto your repository page. Select `Settings` > `Secrets and variables` > `Actions` > `Secrets` > `New repository secret`. Name: `PERSONAL_GITHUB_TOKEN`; Value: the token you have just generated.
+
+Once you start working on the project, you will see the action adding your contributions to the `README.md` file.
+
+!!! warning
+    Do not change anything in the  `README.md`, this file will be modified and overrided by the action. If you want to change anything, please change `README.md.tpl`.
+
+!!! warning
+    If you protect the main branch in your repository, it will prevents the action from updating the `README.md` file. To solve this issue, you you have to enable force pushes to the protected branch. See [documentation](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule).
+
+
 
 ### Teamwork Self-Assessment