Git Product home page Git Product logo

Comments (9)

mlafeldt avatar mlafeldt commented on September 3, 2024

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.

chriscool avatar chriscool commented on September 3, 2024

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.

mlafeldt avatar mlafeldt commented on September 3, 2024

No, nothing in particular. In fact, I don't like separating code from documentation. So forget about the wiki thing. :)

from sharness.

chriscool avatar chriscool commented on September 3, 2024

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.

chriscool avatar chriscool commented on September 3, 2024

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.

chriscool avatar chriscool commented on September 3, 2024

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.

moy avatar moy commented on September 3, 2024

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.

chriscool avatar chriscool commented on September 3, 2024

@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.

chriscool avatar chriscool commented on September 3, 2024

v1.0.0 is released, so this can be closed.

from sharness.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.