mirror of
				https://github.com/ButlerLogic/action-autotag.git
				synced 2025-10-31 07:16:25 +07:00 
			
		
		
		
	Cleanup docs.
This commit is contained in:
		| @ -104,4 +104,8 @@ If you are building an action that runs after this one, be aware this action pro | ||||
| 1. `tagsha`: The SHA of the new tag. | ||||
| 1. `taguri`: The URI/URL of the new tag reference. | ||||
| 1. `tagmessage`: The messge applied to the tag reference (this is what shows up on the tag screen on Github). | ||||
| 1. `version` will be the version attribute found in the `package.json` file. | ||||
| 1. `version` will be the version attribute found in the `package.json` file. | ||||
|  | ||||
| --- | ||||
|  | ||||
| This action was written and is primarily maintained by [Corey Butler](https://github.com/coreybutler). Copyright © 2019 ButlerLogic and Contributors. | ||||
| @ -1,22 +0,0 @@ | ||||
| # Contributors | ||||
|  | ||||
| ### Checkin | ||||
|  | ||||
| - Do checkin source (src) | ||||
| - Do checkin build output (lib) | ||||
| - Do checkin runtime node_modules | ||||
| - Do not checkin devDependency node_modules (husky can help see below) | ||||
|  | ||||
| ### devDependencies | ||||
|  | ||||
| In order to handle correctly checking in node_modules without devDependencies, we run [Husky](https://github.com/typicode/husky) before each commit. | ||||
| This step ensures that formatting and checkin rules are followed and that devDependencies are excluded. To make sure Husky runs correctly, please use the following workflow: | ||||
|  | ||||
| ``` | ||||
| npm install                                 # installs all devDependencies including Husky | ||||
| git add abc.ext                             # Add the files you've changed. This should include files in src, lib, and node_modules (see above) | ||||
| git commit -m "Informative commit message"  # Commit. This will run Husky | ||||
| ``` | ||||
|  | ||||
| During the commit step, Husky will take care of formatting all files with [Prettier](https://github.com/prettier/prettier) as well as pruning out devDependencies using `npm prune --production`. | ||||
| It will also make sure these changes are appropriately included in your commit (no further work is needed) | ||||
		Reference in New Issue
	
	Block a user
	 Corey Butler
					Corey Butler