Skip to content

Commit

Permalink
Add some info to doc/mkdx.txt to help myself deploying in the future :)
Browse files Browse the repository at this point in the history
  • Loading branch information
SidOfc committed May 17, 2020
1 parent 9a8067c commit 22dfbf2
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions doc/mkdx.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ To jump to this table of contents, use |go| or |gg|.
- |mkdx-contents|, |mkdx-toc|, |mkdx-helptags|, |mkdx-tags|, |mkdx-help|
- |mkdx-menu|
- |mkdx-introduction|
- |mkdx-development|
*mkdx-toc-settings*
Settings `.......................................................` |mkdx-settings|
gf_on_steroids `...............................` |mkdx-setting-gf-on-steroids|
Expand Down Expand Up @@ -2446,4 +2447,38 @@ Deprecated plugs:
While the old plugs will still work, they will no longer restore visual mode
regardless of |mkdx-setting-restore-visual|.

==============================================================================
DEVELOPMENT *mkdx-development*

This section does not describe much yet, it is primarily here so that over
time as I (@SidOfc) moves machines, I can go here to see how to release mkdx
properly, things such as zipping and excluding gifs etc...

mkdx uses tagged releases to indicate a version, whenever a new version is
"done" and the README / CHANGELOG / doc/mkdx.txt files are updated,
tag the commit using:

`git tag -a 'vX.X.X' -m 'vX.X.X'`

where `X.X.X` is replaced by the version number at the top of the file.
Remember that tags must be pushed separately:

`git push && git push --tags`

will perform both a regular `git push` and also `git push --tags` if it
succeeds.

Aside from deploying to git to allow modern installation via plugins, a zip
file must also be created and deployed to
https://www.vim.org/scripts/script.php?script_id=5620.

To keep the filesize within acceptable range, use the following command:

`zip -r mkdx-X.X.X.zip mkdx -x "*git*" -x "*.gif" -x "*test*"`

This excludes git, README gifs, and test files from the final zip.
deploying to vim.org is recommended after pushing the updated README and
CHANGELOG to github. This allows for easier copying of the changelog section
in the README file.

vim:tw=78:sw=4:ft=help:norl:

0 comments on commit 22dfbf2

Please sign in to comment.