avanderhoorn / Semantic-Release-Notes

Retrieving typed Release Note information from a Markdown based syntax
30 stars 4 forks source link

Provide a way to assign a date to each release #11

Open flagbug opened 11 years ago

flagbug commented 11 years ago

As the title says, I think there should be a way to tag a release with an (optional) release-date.

avanderhoorn commented 9 years ago

So what would multiple releases look like?

## Title 1
Summary

**Section 1a
 - Blah
 - Blah2

**Another section 1b**

## Title 2
Summary

**Section 2a
 - Blah
 - Blah2

**Another section 2b**

Also are we agreeing to fail a document that has the presence of multiple heading types or would we say that what ever the lowest heading type that is present is the release one?

JakeGinnivan commented 9 years ago

Unsure what you mean by would we say that what ever the lowest heading type that is present is the release one.

I am leaning towards only one size of headers present in the document

avanderhoorn commented 9 years ago

I was thinking something like:

# Document Title
...

## Release 1
...

## Release 2
....

In this case it would see that multiple heading levels are used and ignore the "#" in favour for the lowest heading level (in this case "##").

I personally don't like this... I don't think its 100% clear.

JakeGinnivan commented 9 years ago

Ah I get you.. Hrrm.

For my scenarios I can't see the need for having a document title inside the release notes. If you publish via jekyll or something the title will come from yaml front-matter and for ReleaseNotes.md the title is inferred from the filename.

I vote for a single header size within a document.

laedit commented 9 years ago

Good for me too, otherwise it's too confusing.

avanderhoorn commented 9 years ago

Great!