About environment variables

This application requires two environment variables. - `GH_TOKEN` - `CODECOV_TOKEN` `GH_TOKEN` is GitHub access token. `CODECOV_TOKEN` is Codecov access token. Add .env.sample file to the repository to make it clear. I haven't set it up to automatically read the contents of .env yet.
kitsuyui · Jun 3, 2023 · 076b4ed · 076b4ed
1 parent 717fb15
commit 076b4ed
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 0 deletions.
diff --git a/.env.sample b/.env.sample
@@ -0,0 +1,2 @@
+GH_TOKEN=ghp_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+CODECOV_TOKEN=00000000-0000-0000-0000-000000000000
diff --git a/.gitignore b/.gitignore
@@ -96,3 +96,4 @@ Cargo.lock
 
 
 coverage.lcov
+.env

diff --git a/.gitignore.in b/.gitignore.in
@@ -8,3 +8,4 @@ gibo dump Windows
 gibo dump macOS
 gibo dump Rust
 echo 'coverage.lcov'
+echo '.env'
diff --git a/README.md b/README.md
@@ -10,6 +10,17 @@ A command line tool for creating and managing multiple repositories.
 cargo install mure
 ```
 
+## Environment variables
+
+This application requires two environment variables.
+
+- `GH_TOKEN`
+- `CODECOV_TOKEN`
+
+`GH_TOKEN` is GitHub access token. `CODECOV_TOKEN` is Codecov access token.
+
+(I haven't set it up to automatically read the contents of .env yet.)
+
 ## Usage
 
 ### directory structure
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		GH_TOKEN=ghp_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
		CODECOV_TOKEN=00000000-0000-0000-0000-000000000000
Original file line number	Diff line number	Diff line change
Expand Up		@@ -96,3 +96,4 @@ Cargo.lock


		coverage.lcov
		.env
Expand Down