Skip to content
This repository has been archived by the owner on Jan 19, 2018. It is now read-only.

PROPOSAL: Single directory for spec, use tagged releases #113

Open
aweiteka opened this issue Jul 9, 2015 · 3 comments
Open

PROPOSAL: Single directory for spec, use tagged releases #113

aweiteka opened this issue Jul 9, 2015 · 3 comments

Comments

@aweiteka
Copy link
Contributor

aweiteka commented Jul 9, 2015

I cannot maintain the spec in its current form. Adding to the spec requires us to guess the next version number, create a directory with that number, copy over the files from the previous version and start updating. This prevents us from using diff as we need to among other issues.

Proposal

  1. Use release tags like everyone else. We have none.
  2. Create a branch with each release for any bugfixes required after release. This allows us to fix something in version n.0 (typo, etc) and create a new release tagged n.1.
  3. Host the current spec on an external site like readthedocs.org or projectatomic.io. We will direct users there.
  4. Master is latest. Any changes are pushed to master.

Implementation

  1. Create a 0.0.1 release branch from the last 0.0.1 commit.
  2. Tag a 0.0.1 release from the last 0.0.1 commit.
  3. Create a 0.0.2 release branch from the last 0.0.2 commit.
  4. Tag a 0.0.2 release from the last 0.0.2 commit.
  5. Commit a change to master that compresses directory into a single directory. Proposed new layout:
├── docs
├── examples
└── spec
    ├── constraint.json
    ├── examples
    │   └── template
    │       ├── artifacts
    │       │   ├── provider1
    │       │   │   ├── pod.json
    │       │   │   └── service.json
    │       │   └── provider2
    │       │       └── file.json
    │       ├── Dockerfile
    │       └── Nulecule
    ├── files
    ├── graph.json
    ├── license.json
    ├── metadata.json
    ├── param.json
    ├── provider.json
    ├── README.md
    ├── requirement.json
    ├── requirements
    │   └── persistentvolume.json
    └── schema.json

ACK?

@aweiteka
Copy link
Contributor Author

aweiteka commented Jul 9, 2015

Dependency: #78

@aweiteka aweiteka changed the title PROPOSAL: Single directory for spec, use tags PROPOSAL: Single directory for spec, use tagged releases Jul 9, 2015
aweiteka added a commit that referenced this issue Jul 9, 2015
Collapse the spec directory structure so a single
directory holds the spec. Moving to a tagged release
model. See discussion in
#113
@goern
Copy link
Contributor

goern commented Jul 10, 2015

lgtm and seems to be in sync with https://github.com/projectatomic/nulecule/blob/master/LIFECYCLE.md

@goern
Copy link
Contributor

goern commented Jul 10, 2015

I have started preparing the projectatomic.io side of things at https://github.com/goern/atomic-site/tree/nulecule/initial-nuleculization

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants