Commit Graph

29 Commits

Author SHA1 Message Date
sobolevn
ca500fa13f Changes how docs are built 2021-05-04 13:01:41 +03:00
sobolevn
5fc8ecbdde Adds hadolint, re-enables shellcheck 2021-05-04 13:01:41 +03:00
sobolevn
e52038b786 Fixes docs generation and improves docs 2021-05-04 13:01:41 +03:00
Josh Smailes
eafd3fc531
Issue548 gh pages in master (#616)
* Migrate docs to master branch, add action to deploy to pages branch on push

* Update docs, build pipeline to reflect new method of updating gh-pages

* Removed make build-gh-pages from post-commit hook

Co-authored-by: Josh Rabinowitz <joshr@joshr.com>
2020-12-15 18:49:51 +03:00
Josh Rabinowitz
a40477ca80 more documentation about contributing and releases 2020-11-23 12:19:05 -05:00
Josh Rabinowitz
c1ac63a60e
update docs regarding builds, setup, and docker (#543)
* update developer docs regarding builds, setup, and docker
* more details about git hooks, PRs, and branch names
* add links, corrections, clarifications, and typo fixes
* link to semver.org
* reorder packages and mention homebrew package
2019-09-20 10:57:32 -04:00
Josh Rabinowitz
aec3ac1ae2
Add note about writing tests. Fix typo. (#471)
Also use affect, not effect, as appropriate.
2019-04-29 18:21:30 -04:00
Simon Massey
8ed0f21635
missing word 2019-04-27 21:35:23 +01:00
Josh Rabinowitz
cb1636a6dc
experimental SECRETS_TEST_VERBOSE shows debug info during tests (#446)
* add a travis target using SECRETS_TEST_VERBOSE=1
* Document SECRETS_TEST_VERBOSE as experimental
* note experimental feature may change or be removed
2019-03-28 07:41:07 -04:00
Josh Rabinowitz
e2754adebe
Doc changes 2019 02 for #351 (#353)
* clarification about killperson and secrets, rephrasing.
* how to develop without docker/test-kitchen
* doc changes about gh-pages branch. other clarifications.
* OSX has been renamed MacOS (except in travis-ci)
2019-03-05 07:09:27 -05:00
Josh Rabinowitz
6188d14539
Documentation additions about code style and philosophy (#361)
* code style in CONTRIBUTING.md and PR template
* make link to CONTRIBUTING.md in .github/PULL_REQUEST_TEMPLATE.md
* mention shellcheck and 'make lint'
* mention that you should update CHANGELOG.md 
* mention spellchecking with aspell
* more spelling fixes
* add to CHANGELOG about style guide/dev philosophy
* remind contributors to update .ronn file/man page
2019-02-21 18:04:23 -05:00
Josh Rabinowitz
83b03b61bc
Aspell fixes (#365)
* spellcheck fixes from aspell
2019-02-21 15:20:34 -05:00
Josh Rabinowitz
26ecd390d6
Fix link to contributors on github. (#332) 2019-01-28 07:16:49 -05:00
Josh Rabinowitz
28e3a9b1c2
added notes about packages and for package maintainers (#301)
* added notes about packages and for package maintainers
* document how git tags interact with deb/rpm deploys
* fix typos
2019-01-14 23:16:41 -05:00
Nikita Sobolev
239c2b63dc
Fixes GNUPG doc links 2018-09-28 11:20:40 +03:00
Nikita Sobolev
d8eff64a0b
Oops, one more fix to the default branch docs
Refs #254
2018-09-28 11:19:39 +03:00
Nikita Sobolev
19a4928580
Fixes default branch misuse
Refs #254

We still need to update the release process information.
2018-09-28 11:18:10 +03:00
joshr
6abdd4523d provide links to gnupg PDF documentation and DETAILS file 2018-07-17 10:26:06 -04:00
Josh Rabinowitz
492d705e02 fix more typos 2018-06-21 08:56:30 -04:00
simbo1905
1045c2a71e Steps to get CI builds running on macOS 2018-06-10 21:06:47 +01:00
Jess
1820bd163f Updated CONTRIBUTING.md (optional) 2018-02-03 16:57:14 +09:00
Carlos Hernandez
760684135d
Update doc, to reflect where ci tests are actually located 2017-11-27 14:21:45 -07:00
Carlos Hernandez
1985575dbf Fix contributing doc, fixes #111, fixes #108 2017-11-27 09:52:08 -07:00
Carlos Hernandez
c9861a1079 Add local ci tests. 2017-09-24 08:03:05 -06:00
sobolevn
12d4b9f6de
Adds new release process.
Changes:
1. Removed any reference of `staging` branch from docs
2. Refactored `hooks` to work with master

Closes #76
2017-03-27 21:51:33 +03:00
sobolevn
728371912e
Version 0.2.2 pre-release
There are a lot of changes, multiple things were refactored: tests,
some commands, building and meta.

Several critical bugs fixed.

Changes:
1. Fixed #74, when `_user_required` was not working after reimporting keys
2. Closes #73, now it is possible to provide multiple emails to the `killperson` command
3. Closes #72, now it is possible to provide multiple emails to the `tell` command
4. Closes #71, now every doc in this project refer to `git-secret.io` instead of old `gh-pages` website
5. Closes #70, now installation section is removed from main `man` file
6. Closes #69, now "See also" section in the `man`s are clickable
7. Closes #61, added "Manual" section to the manuals
8. Refs #38, added `centos` Dockerfile, but `ci` testing is still failing
9. Refs #52, tests are refactored. Added `clean` command tests, removed a lot of hardcoded things, moved tests execution from `./temp` folder to `/tmp`, added a lot of new check in old tests, and some new test cases
10. Refactored `hide` and `clean` commands to be shorter
11. `shellcheck` is now supported with `make lint`

Additional features are not comming to 0.2.2 after this commit.
2017-02-26 18:10:51 +03:00
sobolevn
00deabb0e3
This is a release commit.
Changes:
1. Now everything is tested inside the `docker`-containers and `OSX` images on `travis`.
2. We now have `CONTRIBUTING.md` and `LICENSE.md`. `README.md` is also changed.
3. We have a brand logo.
4. We have autodeploy to `bintray`.
5. Everything is `shellcheck`ed (except `tests/`).

Closes #32 #33 #34 #35 #39
2016-07-10 14:28:48 +03:00
sobolevn
b750ba6da3
some stylechanges in markdown 2016-07-02 16:29:43 +03:00
sobolevn
1e748a3c54
CONTRIBUTING.md added 2016-07-02 16:18:53 +03:00