mirror of
				https://github.com/sharkdp/bat.git
				synced 2025-11-04 09:01:56 +00:00 
			
		
		
		
	Simplify release-checklist.md by printing -h, --help and man in CI (#2183)
				
					
				
			* Simplify release-checklist.md by printing `-h`, `--help` and `man` in CI
Note that we run `find . -name bat.1` before we run anything with
`--all-features`, because `--all-features` is considered a separate
target, and so we will get a different (but identical) `bat.1`. For
example, we might have these:
    ./target/debug/build/bat-218e9538b4996215/out/assets/manual/bat.1
    ./target/debug/build/bat-89d6f56802af023f/out/assets/manual/bat.1
By showing the man page earlier, there is only one `bat.1` to pick from.
* Use plain `man $(find . -name bat.1)`
			
			
This commit is contained in:
		
							
								
								
									
										12
									
								
								.github/workflows/CICD.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										12
									
								
								.github/workflows/CICD.yml
									
									
									
									
										vendored
									
									
								
							@@ -118,6 +118,18 @@ jobs:
 | 
			
		||||
        toolchain: stable
 | 
			
		||||
        default: true
 | 
			
		||||
        profile: minimal
 | 
			
		||||
    - name: Print -h
 | 
			
		||||
      uses: actions-rs/cargo@v1
 | 
			
		||||
      with:
 | 
			
		||||
        command: run
 | 
			
		||||
        args: --locked -- -h
 | 
			
		||||
    - name: Print --help
 | 
			
		||||
      uses: actions-rs/cargo@v1
 | 
			
		||||
      with:
 | 
			
		||||
        command: run
 | 
			
		||||
        args: --locked -- --help
 | 
			
		||||
    - name: Show man page
 | 
			
		||||
      run: man $(find . -name bat.1)
 | 
			
		||||
    - name: Check documentation
 | 
			
		||||
      env:
 | 
			
		||||
        RUSTDOCFLAGS: -D warnings
 | 
			
		||||
 
 | 
			
		||||
@@ -20,8 +20,8 @@
 | 
			
		||||
 | 
			
		||||
## Documentation
 | 
			
		||||
 | 
			
		||||
- [ ] Review the `-h` and `--help` texts
 | 
			
		||||
- [ ] Review the `man` page (`man $(fd -HIp target/release/build.*out/assets/manual/bat.1) | tee`)
 | 
			
		||||
- [ ] Review `-h`, `--help`, and the `man` page. All of these are shown in
 | 
			
		||||
      the output of the CI job called *Documentation*, so look there.
 | 
			
		||||
 | 
			
		||||
## Pre-release checks
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user