EntityAuditBundle - Githubissues

VincentLanglet commented 3 years ago

Now the entityAuditBundle is under the sonata-project there is multiple things to do:

[x] Renaming the 1.0 branch to 1.x
[ ] Updating the README
[x] Adding ISSUE_TEMPLATE and PULL_REQUEST template
[x] Moving the CI from travis to github actions (and maybe fixing the tests)
[x] Allowing php8 (and dropping old php versions)
[x] Adding a lint github actions based on our.
[x] Creating a Makefile
[x] Adding this bundle to the list of project handled by dev-kit
[x] Changing the structure from src/SimpleThings/EntityAudit to src (same for tests)
[x] Deciding what to do with master branch (reset ? merge 1.x into master ?)
[ ] Move docs from README to /docs as rst files
[ ] Enable docs on the Website
[ ] Fix pages working with symfony/framework-bundle >= 5.0 - https://github.com/sonata-project/SonataPageBundle/pull/1279
[x] Update configuration to php - https://github.com/sonata-project/EntityAuditBundle/pull/366
[x] Add routing in xml - https://github.com/sonata-project/EntityAuditBundle/pull/365
[ ] Add final, deprecation and NEXT_MAJOR notes
[ ] All aliases to allow use Sonata\EntityAuditBundle namespace

Next steps will be prepare EntityAuditBundle to MAJOR release:

[ ] Close API
[ ] Remove deprecations and NEXT_MAJOR
[ ] Change namespace to Sonata\EntityAuditBundle

@phansys @wbloszyk Since you're using this bundle, do you want to take some tasks ?

cc @OskarStark

OskarStark commented 3 years ago

Sounds good, can you make it a checklist?

VincentLanglet commented 3 years ago

I started some task https://github.com/sonata-project/EntityAuditBundle/pull/347 But I don't understand why the github actions is not running, even on my fork.

wbloszyk commented 3 years ago

Sure, I can do some of this task. IMO We should keep travis for this package until we upgrade tests from phpunit 4 to symfony/phpunit-bridge 5.1 and change structure to this we are using in sonata.

@VincentLanglet WDYT? Can we wait with your PR?

VincentLanglet commented 3 years ago

In the PR I opened, I already updated from phpunit to symfony/phpunit-bridge. So I don't know why we should wait

wbloszyk commented 3 years ago

@VincentLanglet This PR looks good for me. Action is not running becouse (If I good remember) they configuration are taken from branch, no PR. Proof: https://github.com/sonata-project/sandbox/pull/632 - actions was added in this PR https://github.com/sonata-project/sandbox/pull/633 - actions wad running in this PR

Can you split your PR?

franmomu commented 3 years ago

I started some task sonata-project/EntityAuditBundle#347 But I don't understand why the github actions is not running, even on my fork.

Creating a PR on your own fork should work to see the actions.

VincentLanglet commented 3 years ago

https://github.com/sonata-project/EntityAuditBundle/pull/347 is merged.

There are multiple conflict if I try to merge 1.0 into master. And there will be a lot more when I'll fix the lint in 1.0. I have absolutely no clue about what extra work was done on the master branch, and I'm not sure someone knows. I found commit called "POC" like this one: https://github.com/sonata-project/EntityAuditBundle/commit/60fd292d8ab1344b81ade4f74ec2eccb55f04b74.

Should we reset the master branch to 1.0 ? @sonata-project/contributors

OskarStark commented 3 years ago

cc @tolry any infos that can help?

tolry commented 3 years ago

iirc @davidbadura intended to split library and bundle at some point, but that never got finished, master should probably be discarded/rolled back to 1.0 - maybe David remembers more :slightly_smiling_face:

wbloszyk commented 3 years ago

1.0 is 24 commits ahead and 86 behind master. IMO we should rename master into legacy_master and create new main branch from 1.0. Then we can revision legacy_master and cherry pick what we want.

OskarStark commented 3 years ago

Let's use master instead of main, dev kit only knows about master

OskarStark commented 3 years ago

And let's remove it, it's not stable and not meant to be used imho

wbloszyk commented 3 years ago

And let's remove it, it's not stable and not meant to be used imho

Even if it is not stable branch, we can pick some commits or import some idea. anyway branh an be archive.

VincentLanglet commented 3 years ago

Done !

master was renamed legacy_master 1.0 was renamed 1.x master was created based on 1.x

VincentLanglet commented 3 years ago

Now: https://github.com/sonata-project/EntityAuditBundle/pull/349

VincentLanglet commented 3 years ago

https://github.com/sonata-project/EntityAuditBundle/pull/353

Dev kit is now working for EntityAuditBundle License and Readme are currently untouched.

OskarStark commented 3 years ago

So let's create the docs based on the README 👌🏻 and we can overwrite it

VincentLanglet commented 3 years ago

I made https://github.com/sonata-project/EntityAuditBundle/pull/359 as a first step. I don't know how the doc folder works.

wbloszyk commented 3 years ago

I update this list.

IMO We should consider change type to library and move bundle to the src/Bridge/Symfony/ like in the sonata/*-extensions becouse it can be use as standalone library: https://github.com/sonata-project/EntityAuditBundle#installation-standalone

@sonata-project/contributors

OskarStark commented 3 years ago

We can do this later when all done

VincentLanglet commented 3 years ago

I'm trying to reduce the files in the excluded_files section of the dev-kit update. The EntityAuditBundle has a different licence from the other project. https://github.com/sonata-project/EntityAuditBundle/blob/1.x/LICENSE vs https://github.com/sonata-project/SonataAdminBundle/blob/4.x/LICENSE

I'm not familiar with licences, differences between them and what is needed to change them. @beberlei would you be ok with the change ?

sonata-project / dev-kit

EntityAuditBundle #1405