Skip to content

Commit

Permalink
Document 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 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 --all --prune
git checkout 'main'
git reset --hard 'openSUSE/master'

merge '2654' 'Fix access to the version history of organization-level roles'
pick '5997a3194383e63088a400896dcb7c78f5b562c7' 'Restore now-passing tests'
merge '3058' 'Add surveys during CFP response'
merge '3059' 'Add setting to disable email notifications of comments'
pick '3b4da2f6930bcd09a5cdecd5b0efc57ed80b6c87' 'Configure for deployment to Dokku'
pick '7afa84bb1e4d34e5d0eda2176f1519fff1588307' 'Restore lost admin forms [openSUSE#2975](openSUSE#2975)'

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 transitional 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 branch

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

git --no-pager log --color --oneline 'openSUSE/master'..'main'
  • Loading branch information
AndrewKvalheim committed Sep 14, 2022
1 parent cd40063 commit 21ed26f
Showing 1 changed file with 14 additions and 18 deletions.
32 changes: 14 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,18 @@
[![Build Status](https://travis-ci.org/openSUSE/osem.svg?branch=master)](https://travis-ci.org/openSUSE/osem)
[![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)
[![Security Status](https://hakiri.io/github/openSUSE/osem/master.svg)](https://hakiri.io/github/openSUSE/osem/master)
[![Dependencies](https://badges.depfu.com/badges/8fcd630367d20f5b48d393774c00c5fd/overview.svg)](https://depfu.com/repos/openSUSE/osem)
<a href="https://heroku.com/deploy?template=https://github.com/openSUSE/osem/tree/v1.0">
<img src="https://www.herokucdn.com/deploy/button.svg" height="20px" alt="Deploy">
</a>
# Open Source Event Manager - [osem.io](https://osem.io)
![OSEM Logo](doc/osem-logo.png)
# About this branch

An event management tool tailored to Free and Open Source Software conferences.
Our goal is to run [upstream] OSEM without modifications to its codebase. We currently still make a few modifications in this transitional branch:

## Installation
Please refer to our [installation guide](INSTALL.md).
- [ ] Fix access to the version history of organization-level roles [#2654](https://github.com/openSUSE/osem/pull/2654)
- [ ] Restore now-passing tests [`856867e`](https://github.com/SeaGL/osem/commit/856867ec2eb2ad218887b4d743732fc8c2f6b42b)
- [ ] Add surveys during CFP response [#3058](https://github.com/openSUSE/osem/pull/3058)
- [ ] Add setting to disable email notifications of comments [#3059](https://github.com/openSUSE/osem/pull/3059)
- [ ] Configure for deployment to Dokku [`aede4a9`](https://github.com/SeaGL/osem/commit/aede4a942735f06f83be4338ae12222e006b81d3)
- [ ] Restore lost admin forms [#2975](https://github.com/openSUSE/osem/issues/2975) [`cd40063`](https://github.com/SeaGL/osem/commit/cd4006344df33772a8f931f4d9fca4efadedbbf8)

## How to contribute to OSEM
Please refer to our [contributing guide](CONTRIBUTING.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.

## 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 [[email protected]](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).
## 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

0 comments on commit 21ed26f

Please sign in to comment.