Releases: vitiral/artifact
minor bug fixes
Bug fixes:
This is also a rollup and cleanup of initial work done on the tracker feature. The initial MVP was done by @packapotatoes @TheAustinJones @jmcquown. The tracker feature will be off by default until it is complete.
thanks new contributors
Welcome to the new contributors, @porglezomp, @rubdos and @imp. They have been contributing a fair amount of bug reports as well as pull requests. Welcome! I was on vacation for most of this week, so you did the grunt of the work.
This release is minor and mostly encompases small features, bugfixes and documentation changes.
- @porglezomp fixed a ton of issues related to standardizing the
-h, making everything more unicode compatible and display better in a terminal. - @rubdos added a new
--outputflag toexportto choose a different directory and helped fix some error messages and help messages. - @vitiral added a few minor features and fixes, including adding
exclude_artifact_pathsand having all*_pathsvariables in settings be valid for both files and directories (with tests)
All commits:
- 9dcf93e v0.6.5 release
- 638f4cb fix minor lint error and bump version
- bd0c7c1 fix #97 settings: exclude and include code and artifact paths can specify files AND dirs
- 48b5596 Close #104: Add --output flag for export subcommand
- b23db04 fmt with newest rustfmt
- 394d8bf Fix error message when repo not found (#101)
- fad8890 Trim strings in terms of Unicode width instead of bytes (#100)
- 317dbd1 close #95, fix #93: Improve help message content and formatting
- f1e29ed fully fix ls cmd tests on windows
- ffaec16 fix #94: invalid tutorial commands
- b3daf97 close #91: fix ls command related to viewing
text - 5c0bebb update readme and docs, fix #89
- 4ed6863 Fix #88: update itertools
v0.6.4
This release is mostly to remove features in preparation for the 1.0 release, as well as stabilize the internal "core" modules (note: their stability is not guaranteed in the the 1.0 release. This will just help remove thrashing with the server branch).
Changes:
done attribute
This is a minor release which adds the done attribute for specifications and tests which are "done by definition" or done outside of code.
done is an arbitrary field that can be set on SPC and TST artifacts which defines that artifact as done. It is an error to define something as done AND reference it in code.
Some of the fixed issues are:
bug fix and minor features
This release is primarily for the documentation (and tutorial) overhaul and the addition of the [[REQ-name]] references in text fields.
[[REQ-name]] in the text field will now link to that requirement when rendered on the web. This has no impact on the artifact metadata (it does not affect parts, partof or completion %).
There were also several bugfixes:
- artifact names are now
<a>elements so you can "copy link" etc. - minor Web UI cleanups
- fixed some error messages when there was an invalid settings file.
v0.6.1
1.0 pre-release
artifact soak released: 0.6.0 is the last version before 1.0
This is the last big push to artifact before 1.0. Artifact is a design doc tool made for developers. It allows anyone to easily write and link their design docs both to each other and to source code, making it easy to track how complete their project is. Documents are revision
controllable, can be rendered as a static web page and have a full suite of command line tools for searching, formatting and displaying them.
This release comes with several major improvements, (and breaking changes) most importantly an art export html command which allows you to render your artifacts as a static, searchable site. The way in which this was accomplished (through elm) will be covered in a separate blog post -- but it's inclusion in the artifact commands make it a full featured product for open source developers looking to create design docs and use them to make their project self documenting.
The workflow is relatively simple:
- run the tutorial with
art tutotorialor read Simple Quality, the book I have written - run
art initto initialize a repository - edit your design docs in
design/ - once you want to publish your docs, publish them on github!
The same kind of benefits that inline developer documentation can have (i.e. Doxygen, Sphinx, rustdocs, godocs) is now accessible for your design documents. The fundamental goal of artifact is complete!
Artifact is currently released as version 0.6 with the intention to let it
soak for a month and then (finally) release version 1.0. If you have been
thiking of using artifact for your project but the beta status scared you
away -- now is the time to do it. There are tons of resources including
the wiki and the book to get your started, and the tool is expected to
be extremely stable from this point forward.
Over the next month I will mostly be improving the documentation and making an introductory video.
Improvements
art export htmlcommand to publish your design docs on github- the Web UI has been signiicantly improved
- a search bar has been added to the List View with support for searching in name, parts, partof and text
- the List View has been overhaulded to be more intuitive, with the ability to show/hide columns
- the Edit View can now render both markdown and raw text
- simplifying
settings.tomlconsiderably- removing the ability to set settings outside of
.art/settings.toml(breaking change) - removing the
[settings]key insettings.toml(breaking change)
- removing the ability to set settings outside of
- removing support for "multiple projects" -- only one
.art/settings.tomlproject can be loaded, additional settings files are NOT supported. This may change in the future. Multiple projects is (kind of) supported by just adding all design docs/code to the rootsettings.toml art lsnow has a--type TYPEflag which currently only supportsTYPE==jsonand allows you to pipe artifacts in a machine-readable format over stdout (to a file or another program)v0.5renamed the tool to artifact (from rst)