Skip to content

Commit

Permalink
Document interim branch
Browse files Browse the repository at this point in the history
#!/usr/bin/env bash
set -Eeuxo pipefail

function merge() { id="$1"; title="$2"
  git pull --no-ff --no-commit --strategy-option 'theirs' 'openSUSE' "pull/$id/head"
  git commit --message "Merge #‌$id \"$title\""

  items+=( "- [ ] $title [#$id](https://github.com/openSUSE/osem/pull/$id)" )
}

function merge_draft() { branch="$1"; title="$2"
  git pull --no-ff --no-commit --strategy-option 'theirs' 'AndrewKvalheim' "$branch"
  git commit --message "Merge draft AndrewKvalheim:$branch"

  items+=( "- [ ] $title [\`$branch\`](https://github.com/AndrewKvalheim/osem/tree/$branch)" )
}

function pick() { hash="$1"; title="$2"
  git cherry-pick "$hash"
  rebased="$(git rev-parse HEAD)"

  items+=( "- [ ] $title [\`${rebased:0:7}\`]($rebased)" )
}

function revert() { hash="$1"; title="$2"; note="$3"
  git revert --no-edit "$hash"

  items+=( "- [ ] Revert “$title” [\`${hash:0:7}\`](openSUSE@$hash) ($note)" )
}

items=()

git fetch --prune 'openSUSE'
git checkout 'interim'
git reset --hard 'openSUSE/master'

merge '2654' 'Fix access to the version history of organization-level roles'
merge '3059' 'Add setting to disable email notifications of comments'
merge '3058' 'Add surveys during CFP response'
merge '3140' 'Don’t automatically select a difficulty level'
merge '3243' 'Corrections to proposal help text'
merge_draft 'hide-commercials' 'Restrict commercial management to organizers'
pick '9cac6fdc9c679590c42eb285ab50af54fabe32e6' 'Add notifications of user registrations'
pick '56b9e646b491035cf6aef4025dafcb395fe75a56' 'Configure deployment to Dokku'

IFS=$'\n'
cat << MARKDOWN > 'README.md'
# About this branch

Our goal is to run [upstream] OSEM without modifications to its codebase. We currently still make a few modifications in this interim branch:

${items[*]}

These divergences from upstream should be seen as a to-do list, where completing an item means either solving its need in a general way upstream, or adjusting our procedures to accommodate upstream’s existing capabilities or limitations.

## Guidelines

Don’t develop on this branch. It follows upstream by regularly **rebasing** the above modifications. When a modification is no longer necessary, it will be dropped during the rebase. When there are no remaining modifications, this branch will be deleted.

[upstream]: https://github.com/openSUSE/osem
MARKDOWN
git add 'README.md'
git commit --message "Document interim branch

$(cat "${BASH_SOURCE[0]}")"

git --no-pager log --color --oneline 'openSUSE/master'..'interim'
  • Loading branch information
AndrewKvalheim committed Jun 21, 2023
1 parent 4413524 commit 9d70c24
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
[![Build Status](https://github.com/openSUSE/osem/actions/workflows/spec.yml/badge.svg?branch=master)](https://github.com/openSUSE/osem/actions)
[![Code Climate](https://codeclimate.com/github/openSUSE/osem.png)](https://codeclimate.com/github/openSUSE/osem)
[![codecov](https://codecov.io/gh/opensuse/osem/branch/master/graph/badge.svg)](https://codecov.io/gh/opensuse/osem)
[![Dependencies](https://badges.depfu.com/badges/8fcd630367d20f5b48d393774c00c5fd/overview.svg)](https://depfu.com/repos/openSUSE/osem)
# About this branch

# Open Source Event Manager - [osem.io](https://osem.io)
![OSEM Logo](doc/osem-logo.png)
Our goal is to run [upstream] OSEM without modifications to its codebase. We currently still make a few modifications in this interim branch:

An event management tool tailored to Free and Open Source Software conferences.
- [ ] Fix access to the version history of organization-level roles [#2654](https://github.com/openSUSE/osem/pull/2654)
- [ ] Add setting to disable email notifications of comments [#3059](https://github.com/openSUSE/osem/pull/3059)
- [ ] Add surveys during CFP response [#3058](https://github.com/openSUSE/osem/pull/3058)
- [ ] Don’t automatically select a difficulty level [#3140](https://github.com/openSUSE/osem/pull/3140)
- [ ] Corrections to proposal help text [#3243](https://github.com/openSUSE/osem/pull/3243)
- [ ] Restrict commercial management to organizers [`hide-commercials`](https://github.com/AndrewKvalheim/osem/tree/hide-commercials)
- [ ] Add notifications of user registrations [`70daa82`](https://github.com/SeaGL/osem/commit/70daa826781f8001fb6d09a95716739b23daf9b1)
- [ ] Configure deployment to Dokku [`4413524`](https://github.com/SeaGL/osem/commit/44135243d74140251aac92ab01f2101bfda4d5a6)

## Installation
Please refer to our [installation guide](INSTALL.md).
These divergences from upstream should be seen as a to-do list, where completing an item means either solving its need in a general way upstream, or adjusting our procedures to accommodate upstream’s existing capabilities or limitations.

## How to contribute to OSEM
Please refer to our [contributing guide](CONTRIBUTING.md).
## Guidelines

## Contact
GitHub issues are the primary way for communicating about specific proposed changes to this project. If you have other questions feel free to subscribe to the [opensuse-web@opensuse.org](http://lists.opensuse.org/opensuse-web/) mailinglist, all OSEM contributors are on that list! Additionally you can use #osem channel on [libera.chat IRC](https://libera.chat).
Don’t develop on this branch. It follows upstream by regularly **rebasing** the above modifications. When a modification is no longer necessary, it will be dropped during the rebase. When there are no remaining modifications, this branch will be deleted.

[upstream]: https://github.com/openSUSE/osem

0 comments on commit 9d70c24

Please sign in to comment.