Merge pull request #1117 from ucb-bar/prep-for-main

Prep for `main` as `dev` branch

.github/PULL_REQUEST_TEMPLATE.md

@@ -16,7 +16,7 @@
 
 <!-- must be filled out completely to be considered for merging -->
 **Contributor Checklist**:
-- [ ] Did you set `dev` as the base branch?
+- [ ] Did you set `main` as the base branch?
 - [ ] Did you delete any extraneous prints/debugging code?
 - [ ] (If applicable) Did you add documentation for the feature?
 - [ ] (If applicable) Did you add a test demonstrating the PR?

.github/scripts/check-commit.sh

@@ -51,12 +51,7 @@ search () {
 
 submodules=("cva6" "boom" "ibex" "gemmini" "hwacha" "icenet" "nvdla" "rocket-chip" "sha3" "sifive-blocks" "sifive-cache" "testchipip" "riscv-sodor")
 dir="generators"
-if [ "$GITHUB_REF_NAME" == "master" ] || [ "$GITHUB_REF_NAME" == "dev" ]
-then
-    branches=("master" "main")
-else
-    branches=("master" "main" "dev")
-fi
+branches=("master" "main" "dev")
 search
 
 submodules=("riscv-gnu-toolchain" "riscv-isa-sim" "riscv-pk" "riscv-tests")
@@ -83,22 +78,12 @@ search
 
 submodules=("coremark" "firemarshal" "nvdla-workload" "spec2017")
 dir="software"
-if [ "$GITHUB_REF_NAME" == "master" ] || [ "$GITHUB_REF_NAME" == "dev" ]
-then
-    branches=("master")
-else
-    branches=("master" "dev")
-fi
+branches=("master" "dev")
 search
 
 submodules=("DRAMSim2" "axe" "barstools" "chisel-testers" "dsptools" "rocket-dsp-utils" "torture")
 dir="tools"
-if [ "$GITHUB_REF_NAME" == "master" ] || [ "$GITHUB_REF_NAME" == "dev" ]
-then
-    branches=("master")
-else
-    branches=("master" "dev")
-fi
+branches=("master" "dev")
 search
 
 submodules=("dromajo-src")
@@ -108,12 +93,7 @@ search
 
 submodules=("firesim")
 dir="sims"
-if [ "$GITHUB_REF_NAME" == "master" ] || [ "$GITHUB_REF_NAME" == "dev" ]
-then
-    branches=("master")
-else
-    branches=("master" "dev")
-fi
+branches=("master" "main" "dev")
 search
 
 submodules=("hammer")

.github/workflows/chipyard-run-tests.yml

@@ -1,11 +1,9 @@
 name: chipyard-ci-process
 
 on:
-  # run ci on pull requests targeting dev, master, main only (since the ci runs on the merge commit)
+  # run ci on pull requests targeting main only (since the ci runs on the merge commit)
   pull_request:
     branches:
-      - dev
-      - master
       - main
 
 env:

CONTRIBUTING.md

@@ -3,6 +3,6 @@ Contributing to Chipyard
 
 ### Branch management:
 
-1) github:com/ucb-bar/chipyard: master = stable release. All merges to master must go through PR.
-2) github:com/ucb-bar/chipyard: dev = pre-release non-stable branch with latest features. All merges to dev must go through PR.
-3) Other dependencies pointed at by Chipyard (e.g. firesim, boom): master should be the version submoduled in ucb-bar/chipyard master.
+1) github:com/ucb-bar/chipyard: main = pre-release non-stable branch with latest features. All merges to main must go through PR.
+2) github:com/ucb-bar/chipyard: specific tag = official chipyard release.
+3) Other dependencies pointed at by Chipyard (e.g. firesim, boom): master/main should be the version submoduled in ucb-bar/chipyard main.

README.md

@@ -4,13 +4,13 @@
 
 ## Quick Links
 
-* **DOCUMENTATION**: https://chipyard.readthedocs.io/
+* **STABLE DOCUMENTATION**: https://chipyard.readthedocs.io/
 * **USER QUESTION FORUM**: https://groups.google.com/forum/#!forum/chipyard
 * **BUGS AND FEATURE-REQUESTS**: https://github.com/ucb-bar/chipyard/issues
 
 ## Using Chipyard
 
-To get started using Chipyard, see the documentation on the Chipyard documentation site: https://chipyard.readthedocs.io/
+To get started using Chipyard, see the stable documentation on the Chipyard documentation site: https://chipyard.readthedocs.io/
 
 ## What is Chipyard
 
@@ -22,7 +22,7 @@ Chipyard is actively developed in the [Berkeley Architecture Research Group][ucb
 
 ## Resources
 
-* Chipyard Documentation: https://chipyard.readthedocs.io/
+* Chipyard Stable Documentation: https://chipyard.readthedocs.io/
 * Chipyard (x FireSim) Tutorial: https://fires.im/tutorial
 * Chipyard Basics slides: https://fires.im/micro21-slides-pdf/02_chipyard_basics.pdf
 * Chipyard Tutorial Exercise slides: https://fires.im/micro21-slides-pdf/03_building_custom_socs.pdf