-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
78 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
============= | ||
Configuration | ||
============= | ||
|
||
You need setup age's configuration on your project. | ||
|
||
First setup | ||
=========== | ||
|
||
After install, you can get configuration file as ``.age.toml`` by running command ``age init``. | ||
|
||
.. code-block:: console | ||
:caption: Simple Rust project | ||
age init | ||
.. code-block:: console | ||
:caption: For Python project | ||
age init --preset python | ||
If you want to using sample, Please see `configuration file of project itself <https://github.com/attakei/age-cli/blob/main/.age.toml>`_. | ||
|
||
Configuration values | ||
==================== | ||
|
||
``current_version`` | ||
------------------- | ||
|
||
Version text managed by age. | ||
|
||
.. warning:: | ||
|
||
This is auto-updated value by age. | ||
Do not edit manually. | ||
|
||
``files`` | ||
--------- | ||
|
||
List of target to replace by age. | ||
|
||
.. code-block:: toml | ||
:caption: Simple example | ||
[[files]] | ||
path = "Cargo.toml" | ||
search = "version = \"{{current_version}}\"" | ||
replace = "version = \"{{new_version}}\"" | ||
``files[].path`` | ||
---------------- | ||
|
||
File path of replacement target. | ||
This should be relative path of configuration file. | ||
|
||
``files[].search`` | ||
------------------ | ||
|
||
Search target of file. | ||
This accepts multi-line text and using templating. | ||
|
||
``files[].replace`` | ||
------------------- | ||
|
||
Replacement text for search target of file. | ||
This accepts multi-line text and using templating. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,5 +8,5 @@ There are some steps to use age. | |
:maxdepth: 2 | ||
|
||
installation | ||
setup | ||
configuration | ||
commands |
This file was deleted.
Oops, something went wrong.