Difference between a Github issue and problem?

Post here for help on using FreeCAD's graphical user interface (GUI).
Forum rules
and Helpful information
IMPORTANT: Please click here and read this first, before asking for help

Also, be nice to others! Read the FreeCAD code of conduct!
chrisb
Veteran
Posts: 53945
Joined: Tue Mar 17, 2015 9:14 am

Difference between a Github issue and problem?

Post by chrisb »

I wanted to create a ticket concerning an bug in AddonManager. I can choose between "Report a problem" and "Report an issue".
Can someone please explain what the difference is and when to choose which?

https://github.com/FreeCAD/FreeCAD/issues/new/choose
A Sketcher Lecture with in-depth information is available in English, auf Deutsch, en français, en español.
User avatar
chennes
Veteran
Posts: 3884
Joined: Fri Dec 23, 2016 3:38 pm
Location: Norman, OK, USA
Contact:

Re: Difference between a Github issue and problem?

Post by chennes »

@sliptonic added the “problem” template there, maybe he can weigh in. I’ve just kept using “issue” for everything, but I guess that’s not right.
Chris Hennes
Pioneer Library System
GitHub profile, LinkedIn profile, chrishennes.com
chrisb
Veteran
Posts: 53945
Joined: Tue Mar 17, 2015 9:14 am

Re: Difference between a Github issue and problem?

Post by chrisb »

chennes wrote: Sat Nov 26, 2022 2:56 am @sliptonic added the “problem” template there, maybe he can weigh in. I’ve just kept using “issue” for everything, but I guess that’s not right.
Thanks! Here is already the description of the issue:
  • On opening AddonManager I see immediately the following error message in report view:

    Code: Select all

    14:09:21  An error occurred updating macros from GitHub, trying clean checkout...:
    Command '['/usr/bin/git', 'clone', '--recurse-submodules', 'https://github.com/FreeCAD/FreeCAD-macros.git', '/Users/cb/Library/Caches/FreeCAD/Cache/AddonManager/Macros']' returned non-zero exit status 1.
    14:09:21  /Users/cb/Library/Caches/FreeCAD/Cache/AddonManager/Macros
    14:09:21  Attempting to do a clean checkout...
    14:09:21  Traceback (most recent call last):
    14:09:21    File "/Users/cb/Desktop/FreeCAD.app/Contents/Resources/Mod/AddonManager/addonmanager_git.py", line 368, in _synchronous_call_git
    14:09:21      proc = subprocess.run(
    14:09:21    File "/Users/cb/Desktop/FreeCAD.app/Contents/Resources/lib/python3.10/subprocess.py", line 524, in run
    14:09:21      raise CalledProcessError(retcode, process.args,
    14:09:21  subprocess.CalledProcessError: Command '['/usr/bin/git', 'clone', '--recurse-submodules', 'https://github.com/FreeCAD/FreeCAD-macros.git', '/Users/cb/Library/Caches/FreeCAD/Cache/AddonManager/Macros']' returned non-zero exit status 1.
    14:09:21  
    The above exception was the direct cause of the following exception:
    
    14:09:21  Traceback (most recent call last):
    14:09:21    File "/Users/cb/Desktop/FreeCAD.app/Contents/Resources/Mod/AddonManager/addonmanager_workers_startup.py", line 324, in _update_local_git_repo
    14:09:21      self.git_manager.clone(
    14:09:21    File "/Users/cb/Desktop/FreeCAD.app/Contents/Resources/Mod/AddonManager/addonmanager_git.py", line 79, in clone
    14:09:21      self._synchronous_call_git(final_args)
    14:09:21    File "/Users/cb/Desktop/FreeCAD.app/Contents/Resources/Mod/AddonManager/addonmanager_git.py", line 375, in _synchronous_call_git
    14:09:21      raise GitFailed(str(e)) from e
    14:09:21  addonmanager_git.GitFailed: Command '['/usr/bin/git', 'clone', '--recurse-submodules', 'https://github.com/FreeCAD/FreeCAD-macros.git', '/Users/cb/Library/Caches/FreeCAD/Cache/AddonManager/Macros']' returned non-zero exit status 1.
    14:09:21  
    During handling of the above exception, another exception occurred:
    
    14:09:21  Traceback (most recent call last):
    14:09:21    File "/Users/cb/Desktop/FreeCAD.app/Contents/Resources/Mod/AddonManager/addonmanager_workers_startup.py", line 87, in run
    14:09:21      self._retrieve_macros_from_git()
    14:09:21    File "/Users/cb/Desktop/FreeCAD.app/Contents/Resources/Mod/AddonManager/addonmanager_workers_startup.py", line 273, in _retrieve_macros_from_git
    14:09:21      update_succeeded = self._update_local_git_repo()
    14:09:21    File "/Users/cb/Desktop/FreeCAD.app/Contents/Resources/Mod/AddonManager/addonmanager_workers_startup.py", line 342, in _update_local_git_repo
    14:09:21      os.chdir(
    14:09:21  FileNotFoundError: [Errno 2] No such file or directory: '/Users/cb/Library/Caches/FreeCAD/Cache/AddonManager/Macros/..'
    
  • The AddonManager loads everytime some package.xml and metadata files, to be seen in its bottom line, like updating its cache (could be normal)
  • The only macro I see is DesignSPhysics
  • I tried updating Curves workbench. It worked only partially. In the list it says version 0.6.1. When selecting the workbench it says in the detail view version 0.58, and that an update is available.

    On entering the detail view I see another warning (in orange) in report view, saying

    Code: Select all

    14:18:24  AddonManager: Unable to fetch git updates for workbench Curves
    14:18:24  Command '['/usr/bin/git', 'status', '-sb', '--porcelain']' returned non-zero exit status 1.
    
    It should be noted that git is located in /usr/local/bin
  • Trying an update shows this error (red):

    Code: Select all

    14:19:58  Traceback (most recent call last):
    14:19:58    File "/Users/cb/Desktop/FreeCAD.app/Contents/Resources/Mod/AddonManager/addonmanager_git.py", line 368, in _synchronous_call_git
    14:19:58      proc = subprocess.run(
    14:19:58    File "/Users/cb/Desktop/FreeCAD.app/Contents/Resources/lib/python3.10/subprocess.py", line 524, in run
    14:19:58      raise CalledProcessError(retcode, process.args,
    14:19:58  subprocess.CalledProcessError: Command '['/usr/bin/git', 'fetch']' returned non-zero exit status 1.
    14:19:58  
    The above exception was the direct cause of the following exception:
    
    14:19:58  Traceback (most recent call last):
    14:19:58    File "/Users/cb/Desktop/FreeCAD.app/Contents/Resources/Mod/AddonManager/addonmanager_workers_installation.py", line 153, in run_git_update
    14:19:58      self.git_manager.update(clonedir)
    14:19:58    File "/Users/cb/Desktop/FreeCAD.app/Contents/Resources/Mod/AddonManager/addonmanager_git.py", line 102, in update
    14:19:58      self._synchronous_call_git(["fetch"])
    14:19:58    File "/Users/cb/Desktop/FreeCAD.app/Contents/Resources/Mod/AddonManager/addonmanager_git.py", line 375, in _synchronous_call_git
    14:19:58      raise GitFailed(str(e)) from e
    14:19:58  addonmanager_git.GitFailed: Command '['/usr/bin/git', 'fetch']' returned non-zero exit status 1.
    14:19:58  
    During handling of the above exception, another exception occurred:
    
    14:19:58  Traceback (most recent call last):
    14:19:58    File "/Users/cb/Desktop/FreeCAD.app/Contents/Resources/Mod/AddonManager/addonmanager_workers_installation.py", line 107, in run
    14:19:58      self.run_git(target_dir)
    14:19:58    File "/Users/cb/Desktop/FreeCAD.app/Contents/Resources/Mod/AddonManager/addonmanager_workers_installation.py", line 141, in run_git
    14:19:58      self.run_git_update(clonedir)
    14:19:58    File "/Users/cb/Desktop/FreeCAD.app/Contents/Resources/Mod/AddonManager/addonmanager_workers_installation.py", line 164, in run_git_update
    14:19:58      except GitFailed as e:
    14:19:58  NameError: name 'GitFailed' is not defined
    

Code: Select all

OS: macOS 13.0
Word size of FreeCAD: 64-bit
Version: 0.21.31035 (Git)
Build type: Release
Branch: master
Hash: c8074a972ee233d303e50e5d525aecae09c1cd04
Python 3.10.6, Qt 5.15.4, Coin 4.0.0, Vtk 9.1.0, OCC 7.6.3
Locale: C/Default (C)
Installed mods: 
  * FC_SU
  * DynamicData 2.46.0
  * FeedsAndSpeeds 0.4.0
  * fcgear 1.0.0
  * fasteners 0.4.16
  * sheetmetal 0.2.57
  * ExplodedAssembly
  * Curves 0.5.8
A Sketcher Lecture with in-depth information is available in English, auf Deutsch, en français, en español.
User avatar
chennes
Veteran
Posts: 3884
Joined: Fri Dec 23, 2016 3:38 pm
Location: Norman, OK, USA
Contact:

Re: Difference between a Github issue and problem?

Post by chennes »

Can you open the addon manager preferences and set the path to git? I think I expose it there.
Chris Hennes
Pioneer Library System
GitHub profile, LinkedIn profile, chrishennes.com
chrisb
Veteran
Posts: 53945
Joined: Tue Mar 17, 2015 9:14 am

Re: Difference between a Github issue and problem?

Post by chrisb »

Thanks!
No errors on opening.
Updating the cache only once.
Update of workbench ok.
All macros available.

Sorry for the rant, I didn't have the idea that it could be configured, because it used to work before.
Would it be sensible to leave this blank and search in that case the system's PATH?
A Sketcher Lecture with in-depth information is available in English, auf Deutsch, en français, en español.
User avatar
chennes
Veteran
Posts: 3884
Joined: Fri Dec 23, 2016 3:38 pm
Location: Norman, OK, USA
Contact:

Re: Difference between a Github issue and problem?

Post by chennes »

chrisb wrote: Sat Nov 26, 2022 6:11 pm Would it be sensible to leave this blank and search in that case the system's PATH?
Yes, setting it to a blank will trigger the Addon Manager to redo its search.
Chris Hennes
Pioneer Library System
GitHub profile, LinkedIn profile, chrishennes.com
user1234
Veteran
Posts: 3349
Joined: Mon Jul 11, 2016 5:08 pm

Re: Difference between a Github issue and problem?

Post by user1234 »

[rant]To be brutally honest, the new issue regulatory is a mess. There is no triage more, because the most people who do this, have no gh. Also if you do it, you have to maintain it in the forum parallel, and in worst case, the on one issue on both places. And also, many users, who post a issue in gh, post is not in a good way.

Before, if an issue was relevant, it get a ticket, if not it vanished in the deep of the forum database. Now irrelevant things, even false positive, get a number in a list, where you can not see any priority or relevance at all and you do not know where to start with tests. And if you look ticket, you have to scroll through an unstructured anything, often even not understandable. Just said, even in the mantis tracker, you need only one look of the header of the ticket and you (more or less) know what you are dealing with it.

I can understand, that for the developers gh tickets are better, because you can better refer to code, but for maintenance it is the worst (the way how it is done now).[/rant]

Greetings
user1234
chrisb
Veteran
Posts: 53945
Joined: Tue Mar 17, 2015 9:14 am

Re: Difference between a Github issue and problem?

Post by chrisb »

I'm not happy with the new structure either. While everything concerning FreeCAD used to be concentrated in the forum, I see now a splitting into various channels.
An argument to move away from the forum was, that a discussion here is only linear. The developers have a telegram channel with probably thousands of entries, and they are, let's be honest, all in a sequence. Versioning, background colors, polls, wiki, toponaming. So the advantage is not yet there.
I haven't seen on Github either any non sequential discussion, but that may be something to come, and finally it is not the most important thing, what I think about the new process. I have until now only done testing and that is - for me - now reduced, because I am here rather busy with support and don't want to check every now and then another platform. I had advocated first level support in the forum, because I see here more false positives than real bugs, but if the developers are more happy with having it all on Github, let's try it.

A change of workflow usually starts with a degradation before things improve. That leads to three questions:

1) What has to be done to improve the process?
2) How can we measure the quality of the process? Number of commits; happiness of developers, happiness of users? This is very difficult, because the developers are not constantly working with the same time investment.
3) How long should we follow this process, before deciding finally if we should keep it, return to the old system, or do something completely different.
A Sketcher Lecture with in-depth information is available in English, auf Deutsch, en français, en español.
User avatar
onekk
Veteran
Posts: 6149
Joined: Sat Jan 17, 2015 7:48 am
Contact:

Re: Difference between a Github issue and problem?

Post by onekk »

It is as usual a matter if taste.

Github has a great advantages.

But the fact that every user should pollute github with "untested" bug reports is an advantage?

I think it is not as you have no means to check the reputation of user that "make the bug report" and there us much noise this times.

Forum discussion are better ways to focus the problem before "raising a bug" as there are many flavours around of FC and not rarely problems could be related to things like graphics drivers or things that are "out of control" of FC.

But if developers are happy, and this thing will ease their work, I left them to judge and react.

From an user point if view as the change was after some developers have declared to be tired to follow some forum threads, probably they are happy with it.

What is lacking IMHO is a real effort to "document" FC inner working to lower "entry barrier" for "new developer".

I know that the "developer club" is relatively small in almost any OpenSource project, and that to spot "good developing practices" among different projects is very hard, probably it is better to leave them judgements.

I fear that if some new pandemic will invalidate a couple of defelopers FC development will stall forever, as there seems to be nit many people that could take over the project itself.

I will be very happy to be wrong! As I appreciate developers works (thanks and sorry for being a Cassandra with this post) and how FC is going to.

Regards

Carlo D.
Last edited by onekk on Mon Nov 28, 2022 9:19 am, edited 1 time in total.
GitHub page: https://github.com/onekk/freecad-doc.
- In deep articles on FreeCAD.
- Learning how to model with scripting.
- Various other stuffs.

Blog: https://okkmkblog.wordpress.com/
GeneFC
Veteran
Posts: 5373
Joined: Sat Mar 19, 2016 3:36 pm
Location: Punta Gorda, FL

Re: Difference between a Github issue and problem?

Post by GeneFC »

The big problem with github is that there is so much housekeeping stuff mixed in that the meat of the discussion is very hard to follow. Fine for code details, but not for philosophy and strategy.

I understand that splitting the discussion between two rather different formats is problematic, but pushing everything to github simply means the discussion will be much more limited. :(

Gene
Post Reply