Commit 3feeedd5 authored by Aral Balkan's avatar Aral Balkan

Rename App ID to org.small_tech.Gnomit + other misc. improvements

parent 9d66bc10
......@@ -10,11 +10,11 @@ Nothing yet.
## [2.0.0] - 2020-01-22
Initial release under org.small-tech.Gnomit App ID.
Initial release under org.small_tech.Gnomit App ID.
### Changed
- (Breaking Change) App ID is now org.small-tech.Gnomit.
- (Breaking Change) App ID is now org.small_tech.Gnomit.
- Publish delay hours set to 0 to remove Flathub publishing delay.
### Removed
......
......@@ -6,7 +6,7 @@ I appreciate any contributions you may have.
2. Issue a pull request on [the Gnomit GitHub mirror](https://github.com/small-tech/gnomit) (preferred) or send a patch file to aral@small-tech.org.
Please __do not__ open issues or send pull requests on [the Flathub repository](https://github.com/flathub/org.small-tech.Gnomit/).
Please __do not__ open issues or send pull requests on [the Flathub repository](https://github.com/flathub/org.small_tech.Gnomit/).
Thanks!
......
......@@ -6,36 +6,74 @@ Gnomit is a simple Git commit message editor for Gnome, inspired by the excellen
Gnomit is written in [GJS](https://gitlab.gnome.org/GNOME/gjs/wikis/Home)[^1], uses [Flatpak](https://www.flatpak.org/), and is built with [Gnome Builder](https://wiki.gnome.org/Apps/Builder).
## Features
- Highlights overflow of subject line when it exceeds 69 characters.
- Inserts empty line between subject line and rest of message.
- Has spell checking.
- Select All selects only your commit message, not the Git commit comment.
- Displays project folder and branch in window header.
- Git Commit comment is not editable.
- Dark theme support: the overflow highlight is adjusted according to your theme.
## Like this? Fund us!
[Small Technology Foundation](https://small-tech.org) is a tiny, independent not-for-profit.
We exist in part thanks to patronage by people like you. If you share [our vision](https://small-tech.org/about/#small-technology) and want to support our work, please [become a patron or donate to us](https://small-tech.org/fund-us) today and help us continue to exist.
## Installation
You can install Gnomit [via Gnome Software](https://wiki.gnome.org/Apps/Software), [from Flathub](https://flathub.org/apps/details/ind.ie.Gnomit), or from my web site.
You can install Gnomit using [Gnome Software](https://wiki.gnome.org/Apps/Software) and [Pop!_Shop](https://github.com/pop-os/shop) ([Pop!_OS](https://system76.com/pop) 20.04+), [from Flathub](https://flathub.org/apps/details/org.small_tech.Gnomit), or from [my web site](https://ar.al).
### Gnome Software
### Gnome Software & Pop!_Shop
1. Launch Gnome Software and search for Gnomit.
1. Launch Gnome Software/Pop!_Shop and search for Gnomit.
2. Hit the _Install_ button.
3. Set Gnomit as your Git editor:
```bash
git config --global core.editor "flatpak run org.small-tech.Gnomit"
```sh
git config --global core.editor "flatpak run org.small_tech.Gnomit"
```
### Flathub
1. Make sure you’ve [set up Flathub](https://flatpak.org/setup/).
2. In Terminal:
```bash
flatpak install flathub org.small-tech.Gnomit
```sh
flatpak install flathub org.small_tech.Gnomit
```
3. Set Gnomit as your Git editor:
```bash
git config --global core.editor "flatpak run org.small-tech.Gnomit"
```sh
git config --global core.editor "flatpak run org.small_tech.Gnomit"
```
### From my web site
Installing from Gnome Software/Pop!_Shop or Flathub is recommeded as you will be notified of updates and can easily update them.
That said, it is nice not to have to rely solely on centralised App Stores.
So, if you want to, you can also install Gnomit directly from my web site:
1. Download [Gnomit version 2.0.0](https://ar.al/downloads/gnomit/2.0.0/org.small_tech.Gnomit.flatpak).
2. In Terminal, from the directory you downloaded the Gnomit flatpak to:
```sh
flatpak install org.small_tech.Gnomit.flatpak
```
3. Set Gnomit as your Git editor:
```sh
git config --global core.editor "flatpak run org.small_tech.Gnomit"
```
## Usage
Gnomit will pop up automatically when you make a commit in one of your projects.
......@@ -44,15 +82,13 @@ To save your commit message, either press the Commit button or press _Ctrl+Retur
To dismiss Gnomit and cancel your commit message, press _Escape_.
## Features
## Help
- Highlights overflow of subject line when it exceeds 69 characters.
- Inserts empty line between subject line and rest of message.
- Has spell checking.
- Select All selects only your commit message, not the Git commit comment.
- Displays project folder and branch in window header.
- Git Commit comment is not editable.
- Dark theme support: the overflow highlight is adjusted according to your theme.
To see the help screen, in Terminal:
```sh
flatpak run org.small_tech.Gnomit --help
```
## Known issues
......@@ -62,7 +98,7 @@ This is a Flatpak issue. Gnomit will use your system theme [if it is installed v
## Development notes
The following setting in _source.org.Gnomit.json_ allows the app to use mock data when run from Gnome Builder. If you want to test the behaviour of the app when it receives no command-line arguments from within Builder, remove this line. Also note that this path is relative to your home folder. You must update it to point to where you stored your Gnomit working directory for your Builder build to succeed.
The following setting in _org.small_tech.Gnomit.json_ allows the app to use mock data when run from Gnome Builder. If you want to test the behaviour of the app when it receives no command-line arguments from within Builder, remove this line. Also note that this path is relative to your home folder. You must update it to point to where you stored your Gnomit working directory for your Builder build to succeed.
```json
"x-run-args" : [
......@@ -70,17 +106,6 @@ The following setting in _source.org.Gnomit.json_ allows the app to use mock dat
],
```
Similarly, the following setting is hardcoded to the source folder and is required by the deployment script:
```json
"sources" : [
{
"type" : "git",
"url" : "file:///home/aral/ind.ie/gnomit/gjs"
}
]
```
## Deployment
To publish to Flathub (proper credentials required):
......@@ -98,12 +123,39 @@ To publish to Flathub (proper credentials required):
That’s it! Then wait for the changes to propagate on the Flathub web site.
## Deployment Notes
The following setting is hardcoded to the source folder and is required by the deployment script. Since I’m the only one with deployment privileges at the moment, you should be able to ignore this.
```json
"sources" : [
{
"type" : "git",
"url" : "file:///home/aral/small-tech/gnomit/gjs"
}
]
```
Also, note that if you change where the source is located, you will also have to delete the `local-gnomit-repository` flathub repository that is added as a path to your local Flatpak repository:
```sh
flatpak remote-delete local-gnomit-repository
```
The deployment script will recreate it with the correct path for you.
## Contributors
* [Aral balkan](https://ar.al)
* [Aral Balkan](https://ar.al)
* [Sergey Bugaev](https://mastodon.technology/@bugaevc)
* [Sonny Piers](https://github.com/sonnyp)
## Like this? Fund us!
[Small Technology Foundation](https://small-tech.org) is a tiny, independent not-for-profit.
We exist in part thanks to patronage by people like you. If you share [our vision](https://small-tech.org/about/#small-technology) and want to support our work, please [become a patron or donate to us](https://small-tech.org/fund-us) today and help us continue to exist.
## Copyright
Copyright © 2020 [Aral balkan](https://ar.al), [Small Technology Foundation](https://small-tech.org)
......
......@@ -17,5 +17,3 @@ if not destdir:
print('Compiling GSettings schemas...')
call(['glib-compile-schemas', path.join(datadir, 'glib-2.0', 'schemas')])
desktop_file = i18n.merge_file(
input: 'ind.ie.Gnomit.desktop.in',
output: 'ind.ie.Gnomit.desktop',
input: 'org.small_tech.Gnomit.desktop.in',
output: 'org.small_tech.Gnomit.desktop',
type: 'desktop',
po_dir: '../po',
install: true,
......@@ -15,8 +15,8 @@ if desktop_utils.found()
endif
appstream_file = i18n.merge_file(
input: 'ind.ie.Gnomit.appdata.xml.in',
output: 'ind.ie.Gnomit.appdata.xml',
input: 'org.small_tech.Gnomit.appdata.xml.in',
output: 'org.small_tech.Gnomit.appdata.xml',
po_dir: '../po',
install: true,
install_dir: join_paths(get_option('datadir'), 'appdata')
......@@ -29,7 +29,7 @@ if appstream_util.found()
)
endif
install_data('ind.ie.Gnomit.gschema.xml',
install_data('org.small_tech.Gnomit.gschema.xml',
install_dir: join_paths(get_option('datadir'), 'glib-2.0/schemas')
)
......@@ -41,4 +41,4 @@ if compile_schemas.found()
endif
# Install the icon.
install_data ('ind.ie.Gnomit.svg', install_dir: join_paths(get_option('datadir'), 'icons/hicolor/scalable/apps'))
install_data ('icons/org.small_tech.Gnomit.svg', install_dir: join_paths(get_option('datadir'), 'icons/hicolor/scalable/apps'))
<?xml version="1.0" encoding="UTF-8"?>
<component type="desktop">
<id>ind.ie.Gnomit</id>
<launchable type="desktop-id">ind.ie.Gnomit.desktop</launchable>
<id>org.small_tech.Gnomit</id>
<launchable type="desktop-id">org.small_tech.Gnomit.desktop</launchable>
<name>Gnomit</name>
<developer_name>Aral Balkan (Ind.ie)</developer_name>
<update_contact>hello@ind.ie</update_contact>
<developer_name>Aral Balkan, Small Technology Foundation</developer_name>
<update_contact>hello@small-tech.org</update_contact>
<metadata_license>CC0-1.0</metadata_license>
<project_license>GPL-3.0-or-later</project_license>
<summary>Git commit message editor</summary>
......@@ -13,18 +13,19 @@
<p>Features:</p>
<ul>
<li>Highlights overflow of subject line when it exceeds 69 characters.</li>
<li>Inserts empty line between subject line and the rest of the message.</li>
<li>Inserts empty line between subject line and rest of message.</li>
<li>Has spell checking.</li>
<li>Select All selects only your commit message, not the Git commit comment.</li>
<li>Displays helpful information (like project folder and branch) in the window header.</li>
<li>The Git Commit comment is not editable.</li>
<li>Displays project folder and branch in window header.</li>
<li>Git Commit comment is not editable</li>
<li>Dark theme support: the overflow highlight is adjusted according to your theme.</li>
<li>Supports git commit messages, merge messages, tag messages, git add -p messages, and rebase -i messages.</li>
</ul>
</description>
<url type="homepage">https://github.com/indie-mirror/gnomit</url>
<url type="bugtracker">https://github.com/indie-mirror/gnomit/issues</url>
<url type="donation">https://ind.ie/fund/</url>
<url type="help">https://ind.ie/</url>
<url type="homepage">https://github.com/small-tech/gnomit</url>
<url type="bugtracker">https://github.com/small-tech/gnomit/issues</url>
<url type="donation">https://small-tech.org/fund/</url>
<url type="help">https://small-tech.org/</url>
<icon type="remote" width="512px" height="512px">https://ar.al/2018/08/20/gnomit-flatpak-bundle/gnomit-512.png</icon>
<screenshots>
<screenshot type="default">
......@@ -36,7 +37,7 @@
<release date="2020-04-22" version="1.1.0">
<description>
<p>A number of housekeeping updates thanks to Sonny Piers that fix a warning, update dependencies, hide the desktop entry, and reduce permissions.</p>
<p>This is the last release that will use the App ID ind.ie.Gnomit. Future updates will be released under org.small-tech.Gnomit.</p>
<p>This is the last release that will use the App ID ind.ie.Gnomit. Future updates will be released under org.small_tech.Gnomit.</p>
</description>
</release>
<release date="2018-12-11" version="1.0.7">
......
[Desktop Entry]
Name=Gnomit
Exec=ind.ie.Gnomit
Exec=org.small_tech.Gnomit
Terminal=false
Type=Application
Categories=Development;Utility;RevisionControl;TextEditor;GNOME;GTK;
StartupNotify=true
Icon=ind.ie.Gnomit
Icon=org.small_tech.Gnomit
NoDisplay=true
<?xml version="1.0" encoding="UTF-8"?>
<schemalist gettext-domain="gnomit">
<schema id="ind.ie.Gnomit" path="/ind/ie/Gnomit/">
<schema id="org.small_tech.Gnomit" path="/org/small-tech/Gnomit/">
</schema>
</schemalist>
{
"app-id" : "ind.ie.Gnomit",
"app-id" : "org.small_tech.Gnomit",
"runtime" : "org.gnome.Platform",
"runtime-version" : "3.36",
"sdk" : "org.gnome.Sdk",
"command" : "ind.ie.Gnomit",
"command" : "org.small_tech.Gnomit",
"x-run-args" : [
"ind.ie/gnomit/gjs/tests/merge"
"small-tech/gnomit/gjs/tests/message-with-body"
],
"finish-args" : [
"--filesystem=host",
......@@ -56,9 +56,9 @@
"sources" : [
{
"type" : "git",
"url" : "file:///home/aral/ind.ie/gnomit/gjs"
"url" : "file:///home/aral/small-tech/gnomit/gjs"
}
]
}
]
}
\ No newline at end of file
}
data/ind.ie.Gnomit.desktop.in
data/ind.ie.Gnomit.appdata.xml.in
data/ind.ie.Gnomit.gschema.xml
data/org.small_tech.Gnomit.desktop.in
data/org.small_tech.Gnomit.appdata.xml.in
data/org.small_tech.Gnomit.gschema.xml
src/window.uisrc/main.js
src/window.js
\ No newline at end of file
......@@ -16,10 +16,10 @@ if [ $# -eq 0 ]
fi
# Constants unique to the application.
APP_ID='ind.ie.Gnomit'
GITHUB_ACCOUNT_NAME='indie-mirror'
LOCAL_URL='file:\/\/\/home\/aral\/ind.ie\/gnomit\/gjs'
REMOTE_URL='https:\/\/source.ind.ie\/gnome\/gnomit\/gjs.git'
APP_ID='org.small_tech.Gnomit'
GITHUB_ACCOUNT_NAME='small-tech'
LOCAL_URL='file:\/\/\/home\/aral\/small-tech\/gnomit\/gjs'
REMOTE_URL='https:\/\/source.small-tech\/gnome\/gnomit\/gjs.git'
# General constants.
MANIFEST_FILE_NAME="$APP_ID.json"
......@@ -152,7 +152,7 @@ fi
printf " • Test: creating test environment…"
mkdir "$TEST_DIRECTORY"
echo 'A test' > "$TEST_DIRECTORY/a-test.txt"
git config --global core.editor "flatpak run ind.ie.Gnomit"
git config --global core.editor "flatpak run org.small_tech.Gnomit"
runIn "$TEST_DIRECTORY" "git init"
runIn "$TEST_DIRECTORY" "git add --all"
DONE
......
This diff is collapsed.
pkgdatadir = join_paths(get_option('datadir'), meson.project_name())
gnome = import('gnome')
src_res = gnome.compile_resources('ind.ie.Gnomit.src',
'ind.ie.Gnomit.src.gresource.xml',
src_res = gnome.compile_resources('org.small_tech.Gnomit.src',
'org.small_tech.Gnomit.src.gresource.xml',
gresource_bundle: true,
install: true,
install_dir: pkgdatadir,
)
data_res = gnome.compile_resources('ind.ie.Gnomit.data',
'ind.ie.Gnomit.data.gresource.xml',
data_res = gnome.compile_resources('org.small_tech.Gnomit.data',
'org.small_tech.Gnomit.data.gresource.xml',
gresource_bundle: true,
install: true,
install_dir: pkgdatadir,
......@@ -24,8 +24,8 @@ bin_conf.set('libdir', join_paths(get_option('prefix'), get_option('libdir')))
bin_conf.set('datadir', join_paths(get_option('prefix'), get_option('datadir')))
configure_file(
input: 'ind.ie.Gnomit.in',
output: 'ind.ie.Gnomit',
input: 'org.small_tech.Gnomit.in',
output: 'org.small_tech.Gnomit',
configuration: bin_conf,
install: true,
install_dir: get_option('bindir')
......
<?xml version="1.0" encoding="UTF-8"?>
<gresources>
<gresource prefix="/ind/ie/Gnomit">
<gresource prefix="/org/small_tech/Gnomit">
<file>window.glade</file>
</gresource>
</gresources>
<?xml version="1.0" encoding="UTF-8"?>
<gresources>
<gresource prefix="/ind/ie/Gnomit/js">
<gresource prefix="/org/small_tech/Gnomit/js">
<file>main.js</file>
<file>application.js</file>
<file>window.js</file>
......
......@@ -21,7 +21,7 @@ const {Gtk, GObject} = imports.gi
var GnomitWindow = GObject.registerClass({
Name: 'GnomitWindow',
GTypeName: 'GnomitWindow',
Template: 'resource:///ind/ie/Gnomit/window.glade',
Template: 'resource:///org/small_tech/Gnomit/window.glade',
InternalChildren: ['messageText', 'commitButton', 'cancelButton'],
}, class GnomitWindow extends Gtk.Window {
......@@ -29,7 +29,5 @@ var GnomitWindow = GObject.registerClass({
super._init({
application,
})
}
})
Merge branch 'master' of source.ind.ie:gnome/gnomit
Merge branch 'master' of source.small-tech.org:gnome/gnomit
This is another line.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment