mirror of
				https://github.com/cse110-fa22-group29/cse110-fa22-group29.git
				synced 2025-10-30 11:36:50 +00:00 
			
		
		
		
	add JSDoc ADR,
add JSDoc to publish action
This commit is contained in:
		
							
								
								
									
										10
									
								
								.github/workflows/deploy-githubpages.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										10
									
								
								.github/workflows/deploy-githubpages.yml
									
									
									
									
										vendored
									
									
								
							| @@ -29,8 +29,18 @@ jobs: | ||||
|       url: ${{ steps.deployment.outputs.page_url }} | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|       - name: Install apt updates | ||||
|         run: sudo apt -y update; sudo apt -y upgrade; | ||||
|       - name: Install prerequisites | ||||
|         uses: actions/setup-node@v3 | ||||
|         with: | ||||
|           node-version: 18 | ||||
|       - name: Checkout | ||||
|         uses: actions/checkout@v3 | ||||
|       - name: Install dependencies | ||||
|         run: sudo npm install | ||||
|       - name: Run tests | ||||
|         run: sudo npm run js-doc | ||||
|       - name: Setup Pages | ||||
|         uses: actions/configure-pages@v2 | ||||
|       - name: Upload artifact | ||||
|   | ||||
							
								
								
									
										17
									
								
								specs/adrs/112922-doccumentation-jsdoc.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										17
									
								
								specs/adrs/112922-doccumentation-jsdoc.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,17 @@ | ||||
| # Use JSDoc for JS documentation | ||||
|  | ||||
| - Status: accept | ||||
| - Deciders: Arthur Lu, Marc Reta | ||||
| - Date: 11 / 29 / 22 | ||||
|  | ||||
| ## Decision Drivers | ||||
|  | ||||
| - Need simple way to publish documentation for code | ||||
| - Already documentating infile using JSDoc style | ||||
|  | ||||
| ## Considered Options | ||||
| - JSDoc | ||||
|  | ||||
| ## Decision Outcome | ||||
|  | ||||
| Chosen Option: JSDoc | ||||
		Reference in New Issue
	
	Block a user