Comments (9)
We definitely need a new release with all the changes. I'm fine with aiming for 1.0.
Merging README.git
with our README
or creating a Wiki has been something I never came around to. While it's a good idea in general, I'm not sure whether it's a blocker for 1.0.
from sharness.
About a Wiki, did you think about a GitHub wiki or something else?
Anyway yeah let's plan to make a 1.0 release soon.
from sharness.
No, nothing in particular. In fact, I don't like separating code from documentation. So forget about the wiki thing. :)
from sharness.
Ok, I will take a look at README.git
and anyway make a 1.0 release next week or maybe the week after.
from sharness.
Ok, i am very late but here is what I came up with for the Release Notes:
Release Notes for version v1.0.0
================================
These notes describe changes since the previous v0.3.0 version from
April 3 2013.
The new v1.0.0 version contains both many upstream fixes and
improvements from Git and a lot of specific user contributed features.
We think that Sharness is used and supported by enough projects and
developers, and stable enough, now to be ready for a v1.0.0 version.
Externally visible features
---------------------------
- Add a 'cleanup' api to register cleanup actions, thanks to Dennis
Kaarsemaker.
- Add simple test_seq(), thanks to Christian Couder.
- Add test_pause() from Git, thanks to Christian Couder.
- Add test_must_be_empty(), thanks to Konstantin Koroviev.
- Add SHARNESS_TEST_SRCDIR to run tests from a different directory,
thanks to Mark A. Grondona.
- Implement --long-tests to run EXPENSIVE tests, thanks to Matthieu
Moy.
- Support extensions in a sharness.d directory, thanks to Mark
A. Grondona.
- Interactive tests, thanks to Dennis Kaarsemaker.
Internal improvements and bug fixes
-----------------------------------
- Add a linter that detects broken && chains, thanks to Dennis
Kaarsemaker.
- Export SHELL_PATH, thanks to Christian Couder.
- Fix color support when tput needs ~/.terminfo, thanks to Richard
Hansen.
- Fix pathname of test-results/*.counts file, thanks to Richard
Hansen.
- Sort test scripts before running them, thanks to Richard Hansen.
- Use SHARNESS_TRASH_DIRECTORY to enter the trash directory and drop
the test_dir internal variable, thanks to Alexander Sulfrian.
- A lot of new TTY and sub sharness related tests, thanks to Mark
A. Grondona.
- Build on Travis-CI using a container based build infrastructure,
thanks to Mark A. Grondona.
Documentation improvements
--------------------------
- Mention the Sharness Cookbook in the README, thanks to Mathias
Lafeldt.
- Add alternatives to Sharness like Cram, rnt and ts to the README,
thanks to Roman Neuhauser and Simon Chiang.
- Consistent Markdown headings, thanks to Mathias Lafeldt.
- Replace Contact with Author section, thanks to Mathias Lafeldt.
- New CONTRIBUTING.md document, thanks to Christian Couder.
- Mention Sharnessify a new installation tool, thanks to
Christian Couder.
- Usage clarifications, thanks to Matthieu Moy.
- Improved flag descriptions in the README, thanks to Matthieu Moy.
from sharness.
I am not very happy with the CHANGELOG.md. I'd prefer a "release_notes" or "changelog" directory where we would put the release notes, one file per release.
The reason is that I would like to send an announcement on the Git mailing list, and maybe perhaps elsewhere like the IPFS users mailing list, and it's better to point to or just attach the release notes than to point to or attach the full CHANGELOG.md.
from sharness.
One option is to have a CHANGELOG.md and cut&paste the relevant section to a GitHub release. Then you can point users directly to the GitHub release.
from sharness.
@moy ok I will try that. I will add the above release text to https://github.com/mlafeldt/sharness/blob/master/CHANGELOG.md while trying to not change much its format and send a PR.
from sharness.
v1.0.0 is released, so this can be closed.
from sharness.
Related Issues (20)
- SHARNESS_TEST_SRCDIR and extensions HOT 3
- Sharness self-test fails HOT 2
- Can't locate object method "follower" via package "IO::Pty"
- test_expect_failure test 2 = 2 does not fail with prove HOT 4
- trash dir as home dir when run on Windows HOT 1
- testing scripts with sourced functions HOT 1
- Make a release v1.2 HOT 1
- Usage with `prove` would need more documentation HOT 6
- Calling functions from Git submodule fails with v1.2.0 release (Regression) HOT 8
- Let --help output command line options
- add --tee option from git test-lib.sh HOT 1
- sharness.sh is executable? HOT 3
- Release tarballs are not signed HOT 4
- Clarify purpose of "aggregate-results.sh" HOT 12
- Cleanup actions are only run if no tests failed HOT 8
- Additional test function for string comparison? HOT 5
- Document usage of "trash" directory HOT 2
- Document how to release a new Sharness version HOT 2
- Line feed regression HOT 3
- Lots of dangling branches HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sharness.