Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add templating mechanism with Asciidoc alternative #15

Closed
wants to merge 1 commit into from

Conversation

dvaillant
Copy link
Contributor

fix issue #12

@adoble
Copy link
Owner

adoble commented Jun 3, 2019

I have been putting some thought into how templates should be handled (and what is meant with template). Currently the template is hard coded to use the Nygard lightweight ADR template in English. I have been working on a means of specifying a template file (during the initialization) that can be modified by the tool with the ADR name, date etc. (i.e. the Record fields). As such a user can write their own template using:

  • whatever structure they want to use. For instance, there is some interest in also supporting the MADR structure and organizations may have their own structures.
  • in whatever language they want to use (e.g. German, French, English, ..)
  • in whatever document format they want (e.g. Markdown, Asciidoc, …)

So, for instance a user command could be:

adr init -t ~/templates/madr_template.md

with the template being written in markdown, or

adr init -t ~/dev_templates/my-org-template.txt

with the template being written in asciidoc.

As the command line processing is getting more complicated, I’ve taken some time to refactor the tool to use the Picocli framework (picocli.info). The next step is to develop the general templating mechanism.

As you can see, I’m trying to move away from the hardcoded ADRs to a more flexible option and the PR doesn’t move the tool towards that

@adoble adoble closed this Jun 6, 2019
@adoble
Copy link
Owner

adoble commented Jun 29, 2019

This functionality has now been implemented in release v3.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants