Adding Change Log #1109

vsoch · 2017-10-27T22:26:07Z

Description of the Pull Request (PR):

This PR is an effort to start being better at keeping track of changes, deprecation, and all of these import usage details that are essential for users.

addition of changelog I have added a changelog, and it dates back to the original 1.x (I did this manually and unfortunately can only grab large details).
current PRs I have also added some soon to be merged PRs in development as an example of how we should use it.
Updated Contributing: I separated out the sections about contributions (the PR process vs Documentation for it). I made it more clear that documentation should be added along with a note to this log.

I fixed some other small bugs, but the important thing for discussion here is the changelog. I still have no idea why the extra files for @truatpasteurdotfr are here, I can only guess it was some Github error that now remains in development. As with the other PR, please let me know to remove this or not.

This fixes or addresses the following GitHub issues:

Ref: Release notes do not mention backwards-incompatible changes #1051 Project needs a proper change log #1107

Attn: @singularityware-admin

Force NULL terminator into tf->filename to avoid buffer overflow

alpine ABUILD for versions 2.3.2 and 2.4

in order to make package builds reproducible. See https://reproducible-builds.org/ for why this is good. Requires GNU tar-1.28 or later to be reproducible Using gzip -n to not add a timestamp to the .gz header

Make tar file creation reproducible

Revert "Make tar file creation reproducible"

…into development

GodloveD

@vsoch Thank you for putting this together! A lot of good work in a short period of time. For the most part this looks great. I have some small nitpicky comments, but overall it's just what we need.

GodloveD · 2017-10-30T20:25:48Z

.github/RELEASE_CHECKLIST.md

@@ -3,7 +3,7 @@

 ## Code
 - [] Ensure docs exist at singularityware.github.io for new/updated features
- [] Update version number in `configure.ac`
+- [] Update version number in `configure.ac` and `INSTALL.md`


Is this supposed to be here? Does it conflict with #1112?

They are different things - that PR adds it to the debian install files, and this one is general configuration of Singularity.

GodloveD · 2017-10-30T20:26:44Z

.github/SUPPORT.md

@@ -11,6 +11,7 @@ For issues with code (and especially if you need to share debug output) we recom

 - [Singularity Issues](https://github.com/singularityware/singularity/issues): is recommended for most issues with the Singularity software.
 - [Singularity Hub Issues](https://github.com/singularityhub/singularityhub.github.io/issues): is the board for issues relevant to Singularity Hub.
+ - [Singularity Registry Issues](https://github.com/singularityhub/sregistry/issues): is the board for issues relevant to Singularity Registry


Should really be Singularity Hub right? There may be many Singularity Registries but there is only shub.

No, lol. Singularity Registry is a different thing :)

https://github.com/singularityhub/sregistry

it's even peer reviewed / published!

http://joss.theoj.org/papers/050362b7e7691d2a5d0ebed8251bc01e

it's times like these the stuff I do feels... totally unnoticed lol.

Oh sorry. I thought shub was a special case of a Singularity registry. Nevermind.

It's like homo sapiens and Neanderthal. Maybe some wayward, back in the day common elements (mostly UI) but different beasties under it all!

but yeah Shub (which came first) does deliver the common API endpoints of a registry so Shub works like one too. It's the mamma registry! The HUB.

GodloveD · 2017-10-30T20:29:45Z

CHANGELOG.md

+Each section should include general headers such as **Implemented enhancements** 
+and **Merged pull requests**. All closed issued and bug fixes should be 
+represented by the pull requests that fixed them. This log originated with Singularity 2.4
+and changes prior to that are (unfortunately) done retrospectively. From @olifre, critical items to know are:


Seems sort of weird to shout out olifre here.

why? It's his statements. If I don't it's plagarism.

Because this is basically documentation and it seems unprofessional. But if you feel that you would be a plagiarist without the proper citation I won't argue. I don't feel strongly about it.

I removed it! 5 hours ago :)

GodloveD · 2017-10-30T20:30:23Z

CHANGELOG.md

+ - changed behaviour (recipe sections work differently)
+
+
+## [v3.0](https://github.com/singularityware/singularity/tree/development) (development)


Should probably be 2.4.1 not 3.0.

@gmkurtzer said the next "official" version is 3.0, but I suppose we didn't plan for the bug fixes. I'll change it if it makes you happy.

It's either that or go without a changelog in 2.4.1. 😺

GodloveD · 2017-10-30T20:31:17Z

CHANGELOG.md

+ - This changelog was added.
+
+**Bug Fixes**
+ - .wh.* files leading to permissions errors from Docker aufs extractions are skipped on extraction


Let's keep changes out until they are actually merged. Otherwise we get into a situation where the changelog represents hopes instead of reality.

GodloveD · 2017-10-30T20:34:36Z

CHANGELOG.md

+**Deprecated**
+ - the `create` command is being deprecated in favor of `image.create`
+ - `bootstrap` is being deprecated in favor of `build` (will work through 2.4)
+ - `expand` is being deprecated, as a container can be used as a build base to change it (will work through 2.4)


was deprecated in favor of image.expand and no longer works on images with headers (i.e. after they are built).

GodloveD · 2017-10-30T20:36:47Z

CHANGELOG.md

+## [v2.3.2](https://github.com/singularityware/singularity/tree/v2.3.2) (2017-09-15)
+[Full Changelog](https://github.com/singularityware/singularity/compare/2.3.1...2.3.2)
+
+**Implemented enhancements**


I would prefer if we used 3 hashes instead of bold to delineate subheadings in keeping with markdown syntax. And as an added bonus things will work better in the future if we ever decide to add a toc and put it up online or something.

aye aye cap-i-tan!

https://www.youtube.com/watch?v=46goXXCm9Fo

GodloveD

This looks good to me. @gmkurtzer said we can go ahead and merge this when ready. So I think it's ready. Can you squash the commits or whatever and merge?

vsoch · 2017-10-31T02:09:21Z

Sure thing! I'll wait for it to turn green. My trust in Travis consistency is... squishy at best.

vsoch · 2017-10-31T02:28:26Z

Travis is being wanky, so since there isn't actually any code to test, I'm going to squash and merge. Onwards to a new beginning with better documentation, long live CHANGELOG.md!

* updating support, contributing, and adding changelog * modified: .github/PULL_REQUEST_TEMPLATE.md * removing files * removing weird extra files * keeping old files so still builds * changing... the CHANGElog. So many changes.

truatpasteurdotfr and others added 12 commits October 12, 2017 09:26

alpine ABUILD for versions 2.3.2 and 2.4

ed51312

Merge pull request apptainer#1049 from bauerm97/nullfix

0c1dec8

Force NULL terminator into tf->filename to avoid buffer overflow

Merge pull request apptainer#1041 from truatpasteurdotfr/master

67293a9

alpine ABUILD for versions 2.3.2 and 2.4

Merge branch 'development'

3e338d7

Make tar file creation reproducible

6916fce

in order to make package builds reproducible. See https://reproducible-builds.org/ for why this is good. Requires GNU tar-1.28 or later to be reproducible Using gzip -n to not add a timestamp to the .gz header

Merge pull request apptainer#1083 from bmwiedemann/tar

c469f5f

Make tar file creation reproducible

Revert "Make tar file creation reproducible"

239640a

Merge pull request apptainer#1099 from singularityware/revert-1083-tar

718360b

Revert "Make tar file creation reproducible"

Merge branch 'development' of github.com:singularityware/singularity …

344c979

…into development

updating support, contributing, and adding changelog

d3ba46b

modified: .github/PULL_REQUEST_TEMPLATE.md

6944dd2

removing files

7492cdc

vsoch mentioned this pull request Oct 27, 2017

Release notes do not mention backwards-incompatible changes #1051

Closed

vsoch added 2 commits October 27, 2017 18:34

removing weird extra files

c3334ae

keeping old files so still builds

8d9aab4

GodloveD reviewed Oct 30, 2017

View reviewed changes

vsoch added 3 commits October 30, 2017 13:58

changing... the CHANGElog. So many changes.

65344e4

Merge branch 'development' into add/changelog

ae7b815

Merge branch 'development' into add/changelog

e075b82

GodloveD approved these changes Oct 31, 2017

View reviewed changes

vsoch merged commit 3dda9a9 into apptainer:development Oct 31, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding Change Log #1109

Adding Change Log #1109

vsoch commented Oct 27, 2017

GodloveD left a comment

GodloveD Oct 30, 2017

vsoch Oct 30, 2017

GodloveD Oct 31, 2017

GodloveD Oct 30, 2017

vsoch Oct 30, 2017

GodloveD Oct 31, 2017

vsoch Oct 31, 2017

vsoch Oct 31, 2017

GodloveD Oct 30, 2017

vsoch Oct 30, 2017

GodloveD Oct 31, 2017

vsoch Oct 31, 2017

GodloveD Oct 30, 2017

vsoch Oct 30, 2017

GodloveD Oct 31, 2017

GodloveD Oct 30, 2017

GodloveD Oct 30, 2017

vsoch Oct 30, 2017

GodloveD Oct 30, 2017

vsoch Oct 30, 2017

GodloveD Oct 31, 2017

GodloveD left a comment

vsoch commented Oct 31, 2017

vsoch commented Oct 31, 2017

		- changed behaviour (recipe sections work differently)


		## [v3.0](https://github.com/singularityware/singularity/tree/development) (development)

Adding Change Log #1109

Adding Change Log #1109

Conversation

vsoch commented Oct 27, 2017

GodloveD left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GodloveD left a comment

Choose a reason for hiding this comment

vsoch commented Oct 31, 2017

vsoch commented Oct 31, 2017