Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare project for publishing #411

Merged
merged 13 commits into from
May 21, 2024
Merged

Conversation

kuhnroyal
Copy link
Collaborator

@kuhnroyal kuhnroyal commented May 17, 2024

The main idea here is to get a the publishing working with the current state of the project.
The maplibre_gl_web has never been published.
With the new publishing workflow all packages will hopefully be published with a single tag ( v0.19.0 in this case).

  • raise version to 0.19.0
  • raise min Dart SDK to 3.0.0 as required by the js: ^0.6.7 dependency
  • add pubspec_overrides.yaml files and move overridden local deps there
  • add .pubignore to prevent publishing unnecessary files
  • prepare new publish workflow
  • add supported platforms to pubspec.yaml
  • cancel in progress jobs if new commits are pushed
  • necessary lint fixes and formatting to satisfy Flutter version

* raise version to 0.19.0
* raise min Dart SDK to 3.0.0 as required by the `js: ^0.6.7` dependency
* add `pubspec_overrides.yaml` files and move overridden local deps there
* add `.pubignore` to prevent publishing unnecessary files
* prepare new publish workflow
* add supported platforms to `pubspec.yaml`
@kuhnroyal kuhnroyal self-assigned this May 17, 2024
@kuhnroyal kuhnroyal requested review from stefanschaller, JulianBissekkou and wipfli and removed request for stefanschaller May 17, 2024 13:21
@josxha
Copy link
Collaborator

josxha commented May 17, 2024

Changes are looking good to me. Two things that could get put into consideration:


1 │ part of maplibre_gl;
  │ ^^^^^^^^^^^^^^^^^^^^
  • removing example/pubspec.lock and scripts/pubspec.lock files since those files change often and are recommended to be gitignored, see https://dart.dev/guides/libraries/private-files#the-rules pubspec.lock is already on the gitignore list but the files need to be manual deleted to get ignored.

@kuhnroyal
Copy link
Collaborator Author

Changes are looking good to me. Two things that could put into consideration:

  ╷
1 │ part of maplibre_gl;
  │ ^^^^^^^^^^^^^^^^^^^^
  ╵
  • removing example/pubspec.lock and scripts/pubspec.lock files since those files change often and are recommended to be gitignored, see dart.dev/guides/libraries/private-files#the-rules pubspec.lock is already on the gitignore list but the files need to be manual deleted to get ignored.

Yea, there are 26 issues. I'd rather release and fix them in a follow-up release.
I am sure something will fail anyways :)
This PR is just for getting a baseline published.

@josxha
Copy link
Collaborator

josxha commented May 17, 2024

Both would get solved in #401. I'll split the changes into more pull requests, like requested in #401 (comment).

About publishing the web package: The package uses resources from the MapTiler CDN at the moment, so I'm not sure if publishing would be good before it gets fixed. See here: #409

@josxha
Copy link
Collaborator

josxha commented May 17, 2024

@kuhnroyal Just red #390 (comment) and wanted to ask if you consider this 0.9.0 release as a major or minor release?

In flutter prior v1.0.0, a 0.8.0 to 0.9.0 version bump would normally be considered as a major breaking release, while 0.8.0 to 0.8.1 is a feature or minor release.

Or like it ts described in the dart documentation:

Although semantic versioning doesn't promise any compatibility between versions prior to 1.0.0, the Dart community convention is to treat those versions semantically as well. The interpretation of each number is just shifted down one slot: going from 0.1.2 to 0.2.0 indicates a breaking change, going to 0.1.3 indicates a new feature, and going to 0.1.2+1 indicates a change that doesn't affect the public API. For simplicity's sake, avoid using + after the version reaches 1.0.0.

https://dart.dev/tools/pub/versioning#semantic-versions

.github/workflows/publish-single.yml Outdated Show resolved Hide resolved
.github/workflows/publish-single.yml Show resolved Hide resolved
.github/workflows/publish.yml Outdated Show resolved Hide resolved
Co-authored-by: Joscha <34318751+josxha@users.noreply.github.com>
Co-authored-by: Joscha <34318751+josxha@users.noreply.github.com>
@kuhnroyal
Copy link
Collaborator Author

@josxha I'd suggest we merge this and push a release tag to see what fails.

Copy link
Collaborator

@josxha josxha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright, let's focus on a release. 👍
We should update the documentation before we release. I opened a pull request for this here:

Only thing missing in that pull request is to add all changes that happend since the 0.18.0 version to the CHANGELOG.md file. I tried to track them in the v0.19.0 milestone

@kuhnroyal kuhnroyal merged commit 87ad400 into maplibre:main May 21, 2024
9 checks passed
@kuhnroyal kuhnroyal deleted the publishing branch June 4, 2024 10:52
Remi-deronzier pushed a commit to viamichelin/flutter-maplibre-gl that referenced this pull request Sep 6, 2024
The main idea here is to get a the publishing working with the current
state of the project.
The `maplibre_gl_web` has never been published.
With the new publishing workflow all packages will hopefully be
published with a single tag ( `v0.19.0` in this case).

* raise version to 0.19.0
* raise min Dart SDK to 3.0.0 as required by the `js: ^0.6.7` dependency
* add `pubspec_overrides.yaml` files and move overridden local deps
there
* add `.pubignore` to prevent publishing unnecessary files
* prepare new publish workflow
* add supported platforms to `pubspec.yaml`
* cancel in progress jobs if new commits are pushed
* necessary lint fixes and formatting to satisfy Flutter version

---------

Co-authored-by: Joscha <34318751+josxha@users.noreply.github.com>
Remi-deronzier pushed a commit to viamichelin/flutter-maplibre-gl that referenced this pull request Sep 10, 2024
The main idea here is to get a the publishing working with the current
state of the project.
The `maplibre_gl_web` has never been published.
With the new publishing workflow all packages will hopefully be
published with a single tag ( `v0.19.0` in this case).

* raise version to 0.19.0
* raise min Dart SDK to 3.0.0 as required by the `js: ^0.6.7` dependency
* add `pubspec_overrides.yaml` files and move overridden local deps
there
* add `.pubignore` to prevent publishing unnecessary files
* prepare new publish workflow
* add supported platforms to `pubspec.yaml`
* cancel in progress jobs if new commits are pushed
* necessary lint fixes and formatting to satisfy Flutter version

---------

Co-authored-by: Joscha <34318751+josxha@users.noreply.github.com>
Remi-deronzier pushed a commit to viamichelin/flutter-maplibre-gl that referenced this pull request Sep 10, 2024
The main idea here is to get a the publishing working with the current
state of the project.
The `maplibre_gl_web` has never been published.
With the new publishing workflow all packages will hopefully be
published with a single tag ( `v0.19.0` in this case).

* raise version to 0.19.0
* raise min Dart SDK to 3.0.0 as required by the `js: ^0.6.7` dependency
* add `pubspec_overrides.yaml` files and move overridden local deps
there
* add `.pubignore` to prevent publishing unnecessary files
* prepare new publish workflow
* add supported platforms to `pubspec.yaml`
* cancel in progress jobs if new commits are pushed
* necessary lint fixes and formatting to satisfy Flutter version

---------

Co-authored-by: Joscha <34318751+josxha@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update workflows for pub.dev publishing [High Priority] Web mode broken in pub.dev published version
2 participants